Resources

name path methods description
AccountAppearanceResource
  • /public/v1/accounts/{id}/appearance/customCss
  • DELETE GET PUT
AccountBundleResource
  • /public/v1/accounts/{accountId}/content/bundles
  • /public/v1/accounts/{accountId}/content/bundles/{id}
  • /public/v1/accounts/{accountId}/content/bundles/{id}/courses/{courseId}
  • /public/v1/accounts/{accountId}/content/bundles/{id}/equivalents/{equivalentId}
  • /public/v1/accounts/{accountId}/content/bundles/{id}/courses/{bundleContentId}/customLaunchData
  • /public/v1/accounts/{accountId}/content/bundles/{id}/courses/{courseId}/customLaunchData
  • /public/v1/accounts/{accountId}/content/bundles/{id}/equivalents/{equivalentId}/customLaunchData
  • /public/v1/accounts/{accountId}/content/bundles/{bundleId}/courses/{courseId}/config/basic
  • /public/v1/accounts/{accountId}/content/bundles/{bundleId}/equivalents/{equivalentId}/config/basic
  • /public/v1/accounts/{accountId}/content/bundles/{bundleId}/equivalents/{equivalentId}/config/language
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET PUT
  • GET POST
  • GET POST
  • GET PUT
Manage the relationship between bundles and the accounts they are assigned to.
AccountContentResource
  • /public/v1/accounts/{accountId}/content
  • GET
List account's content (courses and equivalents) and get all dispatch packages.
AccountCourseResource
  • /public/v1/accounts/{accountId}/content/courses
  • /public/v1/accounts/{accountId}/content/courses/{id}
  • /public/v1/accounts/{accountId}/content/courses/{id}/customLaunchData
  • /public/v1/accounts/{accountId}/content/courses/{id}/config/basic
  • GET POST
  • GET
  • GET PUT
  • GET POST
Manage an account's courses and get dispatch packages. Content IDs are content pool content IDs.
AccountEquivalentResource
  • /public/v1/accounts/{accountId}/content/equivalents
  • /public/v1/accounts/{accountId}/content/equivalents/{id}
  • /public/v1/accounts/{accountId}/content/equivalents/{id}/customLaunchData
  • /public/v1/accounts/{accountId}/content/equivalents/{id}/config/basic
  • /public/v1/accounts/{accountId}/content/equivalents/{id}/config/language
  • GET POST
  • GET
  • GET PUT
  • GET POST
  • GET PUT
Manage an account's equivalents and get dispatch packages. Equivalent IDs are content pool equivalent IDs.
AccountLicenseResource
  • /public/v1/accounts/{accountId}/licenses
  • /public/v1/accounts/{accountId}/licenses/{licenseId}
  • /public/v1/accounts/{accountId}/content/bundles/{id}/licenses
  • /public/v1/accounts/{accountId}/content/courses/{id}/licenses
  • /public/v1/accounts/{accountId}/content/equivalents/{id}/licenses
  • GET POST
  • PUT
  • GET POST
  • GET POST
  • GET POST
AccountResource
  • /public/v1/accounts
  • /public/v1/accounts/{id}
  • GET POST
  • GET
Create and get information about accounts.
AccountStatementForwardingResource
  • /public/v1/accounts/{accountId}/statementForwarding
  • /public/v1/accounts/{accountId}/statementForwarding/{statementForwardingId}
  • GET POST
  • DELETE
Managing the statement forwarding pipes configured for an account. Create new forwardings, get the details, or delete them.
ApiAboutResource
  • /public/v1/about
  • GET
Get information about the Content Controller application and its public API.
BundleResource
  • /public/v1/content/bundles
  • /public/v1/content/bundles/{bundleId}
  • GET POST
  • GET
Get the list of bundles, get details of a specific bundle, and create new bundles.
CourseResource
  • /public/v1/content/courses
  • /public/v1/content/courses/{id}
  • /public/v1/content/courses/{id}/{versionId}
  • /public/v1/content/courses/{id}/{versionId}/active
  • /public/v1/content/courses/{id}/{versionId}/config/advanced
  • /public/v1/content/courses/{id}/{versionId}/config/basic
  • GET POST
  • GET POST
  • GET
  • PUT
  • GET POST
  • GET POST
Upload new courses and get information about existing courses.
EquivalentResource
  • /public/v1/content/equivalents
  • /public/v1/content/equivalents/{id}
  • GET POST
  • GET
Creating new equivalents and get information about existing equivalents.
LanguageResource
  • /public/v1/languages
  • GET
Get information about languages supported by Content Controller.
LearnerDataResource
  • /public/v1/learnerData/accounts/{accountId}
  • /public/v1/learnerData/status/{jobId}
  • /public/v1/learnerData/export/accounts/{accountId}/learner/{learnerId}
  • POST
  • GET
  • GET
Resource used to start learner data cleaner jobs.
OAuthTokenResource
  • /public/v1/auth
  • POST
An OAuth 2.0 token endpoint for the client credentials grant.
UsageResource
  • /public/v1/usage/learners
  • /public/v1/usage/account/{accountId}/course
  • GET
  • GET
Get basic usage information.