Helium GraphQL API Reference

Documentation related to available types, queries, mutations, etc. in Helium.

We also have a REST API with additional endpoints not covered in our GraphQL API. Documentation for the REST API can be found here https://api.thoughtindustries.com/#thought-industries-api.

Contact

Get Support

https://discord.gg/cTJBX4muVn

API Endpoints
https://example.thoughtindustries.com/helium

Queries

BadgeLeaderboard

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a BadgeLeaderboard!

Arguments
Name Description
limit - Int

Example

Query
query BadgeLeaderboard($limit: Int) {
  BadgeLeaderboard(limit: $limit) {
    awardType {
      deleted
      icon
      id
      includeOnDashboard
      label
      pluralLabel
    }
    currentUserPosition {
      rank
      total
      user {
        ...UserFragment
      }
    }
    leaders {
      rank
      total
      user {
        ...UserFragment
      }
    }
  }
}
Variables
{"limit": 987}
Response
{
  "data": {
    "BadgeLeaderboard": {
      "awardType": AwardType,
      "currentUserPosition": BadgeLeader,
      "leaders": [BadgeLeader]
    }
  }
}

CatalogContent

Description

Returns catalog content items and meta data matching with the criterias. The results of this query can be affected by providing an authToken header to set a user for the operation. This query has an additional cost of 3 points.

Response

Returns a CatalogContent!

Arguments
Name Description
contentTypes - [String!] The list of content types to be queried.
labels - [String!] The list of aggregation labels. The order of list items will match with argument labels. Labels are custom fields.
page - Int! The page number to return within the collection.
query - String The search query.
resultsDisplayType - ContentItemDisplayType The display type. Defaults to the value configured for catalog from the user's Thought Industries instance. If the catalog is not configured, it falls back to value grid. When the value is calendar, it overrides the values for argument sortColumn to be displayDate and sortDirection to be asc.
sortColumn - SortColumn The content data column used to sort the collection. Defaults to the value configured for catalog from the user's Thought Industries instance. If the catalog is not configured, it falls back to value createdAt. When the value is relevance, it requires the argument query also to be set, or it falls back to value courseStartDate.
sortDirection - SortDirection The direction used to sort the collection. Defaults to the value configured for catalog from the user's Thought Industries instance. If the catalog is not configured, it falls back to value desc. When the argument sortColumn is relevance, it requires the argument query also to be set, or it falls back to value desc.
token - String The secure catalog query. The value is encoded by the secret key of user's Thought Industries instance.
values - [String!] The list of aggregation values. The order of list items will match with argument values. Values are custom fields.

Example

Query
query CatalogContent(
  $contentTypes: [String!],
  $labels: [String!],
  $page: Int!,
  $query: String,
  $resultsDisplayType: ContentItemDisplayType,
  $sortColumn: SortColumn,
  $sortDirection: SortDirection,
  $token: String,
  $values: [String!]
) {
  CatalogContent(
    contentTypes: $contentTypes,
    labels: $labels,
    page: $page,
    query: $query,
    resultsDisplayType: $resultsDisplayType,
    sortColumn: $sortColumn,
    sortDirection: $sortDirection,
    token: $token,
    values: $values
  ) {
    contentItems {
      acceptBadgeUrl
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      badgeName
      badgeUrl
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      credlyBadgeExpiresAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      enrollmentEndDate
      enrollmentStartDate
      expiresAt
      hasChildren
      hideCourseDescription
      id
      imageUrl
      isActive
      issuedAt
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      state
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    meta {
      aggregations {
        ...AggregationFragment
      }
      contentTypeFilterEnabled
      contentTypes
      debug
      displayAuthorsEnabled
      displayBundle {
        ...BundleFragment
      }
      displayDescriptionOnCalendar
      displayStartDateEnabled
      displayTypeCalendarEnabled
      displayTypeGridEnabled
      displayTypeListEnabled
      hasMore
      isCurated
      queryCustomFields
      resultsDisplayType
      selectedSort
      selectedSortColumn
      selectedSortDirection
      sortCourseStartDateEnabled
      sortCreatedAtEnabled
      sortPublishDateEnabled
      sortRelevanceEnabled
      sortTitleEnabled
      sortUpdatedAtEnabled
      tokenLabel
      total
    }
  }
}
Variables
{
  "contentTypes": ["xyz789"],
  "labels": ["xyz789"],
  "page": 987,
  "query": "xyz789",
  "resultsDisplayType": "calendar",
  "sortColumn": "courseStartDate",
  "sortDirection": "asc",
  "token": "xyz789",
  "values": ["xyz789"]
}
Response
{
  "data": {
    "CatalogContent": {
      "contentItems": [Content],
      "meta": CatalogMeta
    }
  }
}

Comments

Description

This query returns a list of comments associated with a commentable type. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a CommentsList

Arguments
Name Description
clientId - ID The ID of the client
commentableId - ID! The ID of the commentable type.
commentableType - CommentableType! The type of thread requested, based on the forum's location, e.g. discussion board, assignment, widget thread etc.
page - Int The page number to return within the collection.
parentId - ID The ID of the parent
userId - ID The ID of the user.

Example

Query
query Comments(
  $clientId: ID,
  $commentableId: ID!,
  $commentableType: CommentableType!,
  $page: Int,
  $parentId: ID,
  $userId: ID
) {
  Comments(
    clientId: $clientId,
    commentableId: $commentableId,
    commentableType: $commentableType,
    page: $page,
    parentId: $parentId,
    userId: $userId
  ) {
    comments {
      asset
      assetFileName
      body
      childComments {
        ...CommentsListFragment
      }
      commentable
      commentableId
      commentableType
      createdAt
      id
      likesCount
      notificationsEnabled
      parentComment {
        ...CommentFragment
      }
      updatedAt
      user {
        ...UserFragment
      }
      userLikeId
      videoAsset
    }
    pageInfo {
      currentPage
      hasMore
      perPage
      total
    }
  }
}
Variables
{
  "clientId": 4,
  "commentableId": 4,
  "commentableType": "assignment",
  "page": 987,
  "parentId": "4",
  "userId": 4
}
Response
{
  "data": {
    "Comments": {
      "comments": [Comment],
      "pageInfo": PageInfo
    }
  }
}

CompanyDetails

Response

Returns a CompanyDetails

Arguments
Name Description
user - ID The ID of the User.

Example

Query
query CompanyDetails($user: ID) {
  CompanyDetails(user: $user) {
    name
    settings {
      accentColor
      altFont
      backgroundAsset
      backgroundAssetTiled
      company {
        ...CompanyFragment
      }
      customCss
      font
      globalNavigationLinks {
        ...GlobalNavigationLinkFragment
      }
      id
      linkColor
      logoAsset
      retinaLogo
      secondaryColor
    }
    subdomain
  }
}
Variables
{"user": "4"}
Response
{
  "data": {
    "CompanyDetails": {
      "name": "xyz789",
      "settings": AppearanceSettings,
      "subdomain": "abc123"
    }
  }
}

CompanyTranslations

Description

Returns translations from the user's Thought Industries instance.

Response

Returns [TranslationsList!]!

Arguments
Name Description
namespace - TranslationNamespace! The namespace is used to specify the content category for the translations. Accepts values of lms for platform content and emails for email content.

Example

Query
query CompanyTranslations($namespace: TranslationNamespace!) {
  CompanyTranslations(namespace: $namespace) {
    id
    lang
    translations
  }
}
Variables
{"namespace": "emails"}
Response
{
  "data": {
    "CompanyTranslations": [
      {
        "id": 4,
        "lang": "xyz789",
        "translations": {}
      }
    ]
  }
}

CourseById

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Course!

Arguments
Name Description
id - ID!

Example

Query
query CourseById($id: ID!) {
  CourseById(id: $id) {
    accessDays
    alternativePricingRef
    alternativePricingType
    appearanceBlock
    appearanceHash
    askLearnerPassword
    availabilityStatus
    awardClaimingOptions {
      awardAmounts
      awardType {
        ...AwardTypeFragment
      }
      awardTypeId
      range
    }
    balanceRequirement
    bulkPurchasingEnabled
    completionTimePerPage
    confirmationBlock
    courseEndDate
    courseGroup {
      allowRescheduling
      archived
      asset
      authors
      availabilityStatus
      contentType {
        ...ContentTypeFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentUserMayReschedule
      customFields
      description
      detailAsset
      displayBundle {
        ...DisplayBundleFragment
      }
      displayCourse {
        ...CourseFragment
      }
      externalDetailUrl
      externalPurchaseUrl
      hasParentCourseGroup
      id
      isbn
      kind
      language
      layout {
        ...LayoutFragment
      }
      metaDescription
      metaTitle
      ownedByActiveScope
      rating
      relatedCourseGroups {
        ...CourseGroupFragment
      }
      relatedQuery
      relatedQueryLimit
      relatedQuerySignature
      relatedQuerySort
      relatedShowDescription
      relatedShowImageAsset
      ribbon
      slug
      source
      tabs {
        ...CourseTabFragment
      }
      tags {
        ...TagFragment
      }
      title
      videoAsset
    }
    courseStartDate
    createdAt
    currentUserHasAccess
    customFields
    discussionsEnabled
    displayMap
    displayResults
    embeddedEnabled
    enrollmentActive
    enrollmentEndDate
    enrollmentStartDate
    finalAssessment
    forceLinearProgress
    freeWithRegistration
    fulfillmentCenter
    futurePublishDate
    galleryEnabled
    gracePeriodEndDate
    hasChildren
    hasMultipleCurrencies
    id
    inPersonEventInfo {
      heroAsset
      subtitle
    }
    instructorAccessEnabled
    instructorAccessPriceInCents
    instructorEmails
    isActive
    isChild
    kind
    lastTierPriceInCents
    linkedWorkbookEnabled
    linkedWorkbookSkipEnabled
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetings {
      attendeeInfo
      attendees {
        ...UserFragment
      }
      course {
        ...CourseFragment
      }
      courseId
      endDate
      id
      instructors
      location {
        ...LocationFragment
      }
      locationId
      startDate
      timeZone
      title
    }
    meetingsOverviewEnabled
    parentCourseId
    paywallsBlock
    prerequisiteCourses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    prerequisiteLearningPaths {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    priceInCents
    prices {
      annualPriceInCents
      currencyCode
      id
      instructorAccessPriceInCents
      priceInCents
      suggestedRetailPriceInCents
      variations {
        ...ItemPriceVariationFragment
      }
    }
    publishDate
    purchasable
    resourcesEnabled
    roster
    rosterSubmittedDate
    sampleLesson {
      accessLevel
      id
      section {
        ...SectionFragment
      }
      slug
      slugOrId
      title
      topics
    }
    sampleLessonId
    scormCollectUserDetails
    seatPackages {
      seats
    }
    seatTiers {
      priceInCents
      seats
    }
    seatsAllocatedCount
    seatsLimit
    seatsLimitMet
    seatsUsedCount
    sections {
      id
      lessons {
        ...LessonFragment
      }
      slug
      status
      title
    }
    sessionIsTitled
    showProgress
    showSyllabusWhileUnenrolled
    sku
    slug
    status
    suggestedRetailPriceInCents
    superquizEnabled
    syllabusTitlesEnabled
    taxCategory
    taxable
    termsBlock
    title
    topicGroup
    updatedAt
    waitlistActive
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
    webinarDates {
      endDate
      startDate
    }
    webinarDetails {
      attendeeDialIn
      coOrganizers
      enableAutoRecording
      id
      joinUrl
      organizerDialIn
      originalWebinarDates {
        ...WebinarDateFragment
      }
      recurrence
      retrieveRecording
      timeZone
      webexDescription
      webexLabName
      webexNumComputers
      webexReserveHOL
      webexSessionPassword
      webinarDates {
        ...WebinarDateFragment
      }
      webinarProvider
      webinarType
    }
    webinarId
    webinarTimeZone
    workbookEnabled
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "CourseById": {
      "accessDays": 123,
      "alternativePricingRef": 123,
      "alternativePricingType": "membership",
      "appearanceBlock": "4",
      "appearanceHash": "abc123",
      "askLearnerPassword": true,
      "availabilityStatus": "abc123",
      "awardClaimingOptions": [CourseAwardClaimingOption],
      "balanceRequirement": 987.65,
      "bulkPurchasingEnabled": false,
      "completionTimePerPage": 987,
      "confirmationBlock": "4",
      "courseEndDate": "2007-12-03",
      "courseGroup": "courseGroup-1",
      "courseStartDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "currentUserHasAccess": false,
      "customFields": {},
      "discussionsEnabled": true,
      "displayMap": false,
      "displayResults": false,
      "embeddedEnabled": false,
      "enrollmentActive": true,
      "enrollmentEndDate": "2007-12-03",
      "enrollmentStartDate": "2007-12-03",
      "finalAssessment": "xyz789",
      "forceLinearProgress": true,
      "freeWithRegistration": false,
      "fulfillmentCenter": 4,
      "futurePublishDate": "2007-12-03",
      "galleryEnabled": false,
      "gracePeriodEndDate": "2007-12-03",
      "hasChildren": true,
      "hasMultipleCurrencies": true,
      "id": "4",
      "inPersonEventInfo": InPersonEventInfo,
      "instructorAccessEnabled": false,
      "instructorAccessPriceInCents": 123,
      "instructorEmails": ["xyz789"],
      "isActive": true,
      "isChild": true,
      "kind": "article",
      "lastTierPriceInCents": 987,
      "linkedWorkbookEnabled": false,
      "linkedWorkbookSkipEnabled": false,
      "location": Location,
      "meetings": [Meeting],
      "meetingsOverviewEnabled": true,
      "parentCourseId": "4",
      "paywallsBlock": "4",
      "prerequisiteCourses": [Course],
      "prerequisiteLearningPaths": [LearningPath],
      "priceInCents": 123,
      "prices": [ItemPrice],
      "publishDate": "2007-12-03",
      "purchasable": false,
      "resourcesEnabled": false,
      "roster": false,
      "rosterSubmittedDate": "2007-12-03",
      "sampleLesson": Lesson,
      "sampleLessonId": "4",
      "scormCollectUserDetails": true,
      "seatPackages": [SeatPackage],
      "seatTiers": [SeatTier],
      "seatsAllocatedCount": 987,
      "seatsLimit": 987,
      "seatsLimitMet": false,
      "seatsUsedCount": 987,
      "sections": [Section],
      "sessionIsTitled": true,
      "showProgress": false,
      "showSyllabusWhileUnenrolled": false,
      "sku": "abc123",
      "slug": Slug,
      "status": "archived",
      "suggestedRetailPriceInCents": 987,
      "superquizEnabled": true,
      "syllabusTitlesEnabled": false,
      "taxCategory": "4",
      "taxable": true,
      "termsBlock": 4,
      "title": "abc123",
      "topicGroup": "4",
      "updatedAt": "2007-12-03",
      "waitlistActive": true,
      "waitlistCount": 123,
      "waitlistingEnabled": true,
      "waitlistingTriggered": false,
      "webinarDates": [DateRange],
      "webinarDetails": WebinarBlock,
      "webinarId": "xyz789",
      "webinarTimeZone": "abc123",
      "workbookEnabled": true
    }
  }
}

CourseGroupBySlug

Description

This query returns the Course Group associated with the slug given.

Response

Returns a CourseGroup

Arguments
Name Description
slug - Slug! The slug for the Course Group being retrieved.

Example

Query
query CourseGroupBySlug($slug: Slug!) {
  CourseGroupBySlug(slug: $slug) {
    allowRescheduling
    archived
    asset
    authors
    availabilityStatus
    contentType {
      assetAspectRatio
      label
    }
    courses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    currentUserMayReschedule
    customFields
    description
    detailAsset
    displayBundle {
      annualPlanId
      annualPriceInCents
      asset
      id
      name
      planId
      priceInCents
      slug
    }
    displayCourse {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    externalDetailUrl
    externalPurchaseUrl
    hasParentCourseGroup
    id
    isbn
    kind
    language
    layout {
      hasEnrollmentWidget
      id
      kind
      scripts
      widgets
    }
    metaDescription
    metaTitle
    ownedByActiveScope
    rating
    relatedCourseGroups {
      allowRescheduling
      archived
      asset
      authors
      availabilityStatus
      contentType {
        ...ContentTypeFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentUserMayReschedule
      customFields
      description
      detailAsset
      displayBundle {
        ...DisplayBundleFragment
      }
      displayCourse {
        ...CourseFragment
      }
      externalDetailUrl
      externalPurchaseUrl
      hasParentCourseGroup
      id
      isbn
      kind
      language
      layout {
        ...LayoutFragment
      }
      metaDescription
      metaTitle
      ownedByActiveScope
      rating
      relatedCourseGroups {
        ...CourseGroupFragment
      }
      relatedQuery
      relatedQueryLimit
      relatedQuerySignature
      relatedQuerySort
      relatedShowDescription
      relatedShowImageAsset
      ribbon
      slug
      source
      tabs {
        ...CourseTabFragment
      }
      tags {
        ...TagFragment
      }
      title
      videoAsset
    }
    relatedQuery
    relatedQueryLimit
    relatedQuerySignature
    relatedQuerySort
    relatedShowDescription
    relatedShowImageAsset
    ribbon
    slug
    source
    tabs {
      body
      id
      instructors {
        ...InstructorFragment
      }
      label
      products {
        ...ProductFragment
      }
      sections {
        ...SectionFragment
      }
      tabType
      testimonials {
        ...TestimonialFragment
      }
    }
    tags {
      id
      isFolder
      label
      updatedAt
    }
    title
    videoAsset
  }
}
Variables
{"slug": Slug}
Response
{
  "data": {
    "CourseGroupBySlug": {
      "allowRescheduling": false,
      "archived": false,
      "asset": "abc123",
      "authors": ["abc123"],
      "availabilityStatus": "xyz789",
      "contentType": ContentType,
      "courses": [Course],
      "createdAt": "2007-12-03",
      "currentUserMayReschedule": false,
      "customFields": {},
      "description": "xyz789",
      "detailAsset": "abc123",
      "displayBundle": DisplayBundle,
      "displayCourse": Course,
      "externalDetailUrl": "xyz789",
      "externalPurchaseUrl": "abc123",
      "hasParentCourseGroup": true,
      "id": 4,
      "isbn": "abc123",
      "kind": "article",
      "language": "abc123",
      "layout": Layout,
      "metaDescription": "xyz789",
      "metaTitle": "xyz789",
      "ownedByActiveScope": false,
      "rating": 123,
      "relatedCourseGroups": [CourseGroup],
      "relatedQuery": "abc123",
      "relatedQueryLimit": 123,
      "relatedQuerySignature": "xyz789",
      "relatedQuerySort": "xyz789",
      "relatedShowDescription": false,
      "relatedShowImageAsset": true,
      "ribbon": Slug,
      "slug": Slug,
      "source": "abc123",
      "tabs": [CourseTab],
      "tags": [Tag],
      "title": "abc123",
      "videoAsset": "abc123"
    }
  }
}

CurrentUser

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a CourseGroup

Arguments
Name Description
slug - Slug!

Example

Query
query CurrentUser($slug: Slug!) {
  CurrentUser(slug: $slug) {
    allowRescheduling
    archived
    asset
    authors
    availabilityStatus
    contentType {
      assetAspectRatio
      label
    }
    courses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    currentUserMayReschedule
    customFields
    description
    detailAsset
    displayBundle {
      annualPlanId
      annualPriceInCents
      asset
      id
      name
      planId
      priceInCents
      slug
    }
    displayCourse {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    externalDetailUrl
    externalPurchaseUrl
    hasParentCourseGroup
    id
    isbn
    kind
    language
    layout {
      hasEnrollmentWidget
      id
      kind
      scripts
      widgets
    }
    metaDescription
    metaTitle
    ownedByActiveScope
    rating
    relatedCourseGroups {
      allowRescheduling
      archived
      asset
      authors
      availabilityStatus
      contentType {
        ...ContentTypeFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentUserMayReschedule
      customFields
      description
      detailAsset
      displayBundle {
        ...DisplayBundleFragment
      }
      displayCourse {
        ...CourseFragment
      }
      externalDetailUrl
      externalPurchaseUrl
      hasParentCourseGroup
      id
      isbn
      kind
      language
      layout {
        ...LayoutFragment
      }
      metaDescription
      metaTitle
      ownedByActiveScope
      rating
      relatedCourseGroups {
        ...CourseGroupFragment
      }
      relatedQuery
      relatedQueryLimit
      relatedQuerySignature
      relatedQuerySort
      relatedShowDescription
      relatedShowImageAsset
      ribbon
      slug
      source
      tabs {
        ...CourseTabFragment
      }
      tags {
        ...TagFragment
      }
      title
      videoAsset
    }
    relatedQuery
    relatedQueryLimit
    relatedQuerySignature
    relatedQuerySort
    relatedShowDescription
    relatedShowImageAsset
    ribbon
    slug
    source
    tabs {
      body
      id
      instructors {
        ...InstructorFragment
      }
      label
      products {
        ...ProductFragment
      }
      sections {
        ...SectionFragment
      }
      tabType
      testimonials {
        ...TestimonialFragment
      }
    }
    tags {
      id
      isFolder
      label
      updatedAt
    }
    title
    videoAsset
  }
}
Variables
{"slug": Slug}
Response
{
  "data": {
    "CurrentUser": {
      "allowRescheduling": false,
      "archived": true,
      "asset": "xyz789",
      "authors": ["abc123"],
      "availabilityStatus": "abc123",
      "contentType": ContentType,
      "courses": [Course],
      "createdAt": "2007-12-03",
      "currentUserMayReschedule": true,
      "customFields": {},
      "description": "xyz789",
      "detailAsset": "abc123",
      "displayBundle": DisplayBundle,
      "displayCourse": Course,
      "externalDetailUrl": "xyz789",
      "externalPurchaseUrl": "xyz789",
      "hasParentCourseGroup": false,
      "id": 4,
      "isbn": "xyz789",
      "kind": "article",
      "language": "abc123",
      "layout": Layout,
      "metaDescription": "xyz789",
      "metaTitle": "xyz789",
      "ownedByActiveScope": false,
      "rating": 987,
      "relatedCourseGroups": [CourseGroup],
      "relatedQuery": "abc123",
      "relatedQueryLimit": 123,
      "relatedQuerySignature": "abc123",
      "relatedQuerySort": "abc123",
      "relatedShowDescription": false,
      "relatedShowImageAsset": true,
      "ribbon": Slug,
      "slug": Slug,
      "source": "xyz789",
      "tabs": [CourseTab],
      "tags": [Tag],
      "title": "abc123",
      "videoAsset": "xyz789"
    }
  }
}

CurrentUser

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a User

Example

Query
query CurrentUser {
  CurrentUser {
    abbreviatedName
    accessedFlows
    activeLicense {
      accessDays
      appearance {
        ...AppearanceSettingsFragment
      }
      childLicenses {
        ...LicenseFragment
      }
      client {
        ...ClientFragment
      }
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      dashboardLayoutId
      enableBranding
      expirationDate
      id
      isDefault
      label
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      name
      parentLicense {
        ...LicenseFragment
      }
      parentLicenseId
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      schoolName
      seatsLimit
      sku
      updatedAt
    }
    address1
    address2
    adminClients {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    allocatedLearningPaths {
      learningPath {
        ...LearningPathFragment
      }
      learningPathId
    }
    allocatedLicenses {
      license {
        ...LicenseFragment
      }
      licenseId
      licenseRole
      status
    }
    asset
    attendedMeetings {
      attendanceDate
      meeting {
        ...MeetingFragment
      }
      user {
        ...UserFragment
      }
    }
    availableCoursesCount
    balance
    bio
    certificatesCount
    city
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    clientId
    collaborationsCount
    completedCoursesCount
    country
    createdAt
    customFields
    disabled
    email
    externalCustomerId
    firstName
    id
    invitedByName
    lang
    lastActiveAt
    lastInitial
    lastName
    learnerUserId
    managerUserId
    mustVerifyEmail
    name
    purchasedBundles {
      bundle {
        ...BundleFragment
      }
      bundleId
    }
    purchasedCourses {
      certificate
      certificateIssuedAt
      course {
        ...CourseFragment
      }
      courseId
      instructorAccessPurchased
      status
    }
    recommendedSlugs {
      boost
      slug
    }
    recommendedTags {
      boost
      label
    }
    ref1
    ref2
    ref3
    ref4
    ref5
    ref6
    ref7
    ref8
    ref9
    ref10
    roleKey
    sfAccountId
    sfContactId
    shippingName
    shouldHighlight
    startedCoursesCount
    state
    stripeCustomerId
    telephone
    twoFactorEnabled
    updatedAt
    waitlistedCourses {
      course {
        ...CourseFragment
      }
      courseId
    }
    zipCode
  }
}
Response
{
  "data": {
    "CurrentUser": {
      "abbreviatedName": "xyz789",
      "accessedFlows": ["xyz789"],
      "activeLicense": License,
      "address1": "xyz789",
      "address2": "xyz789",
      "adminClients": [Client],
      "allocatedLearningPaths": [AllocatedLearningPath],
      "allocatedLicenses": [AllocatedLicense],
      "asset": "abc123",
      "attendedMeetings": [UserAttendedMeeting],
      "availableCoursesCount": 987,
      "balance": 123.45,
      "bio": "abc123",
      "certificatesCount": 123,
      "city": "abc123",
      "client": "client-1",
      "clientId": "client-1",
      "collaborationsCount": 987,
      "completedCoursesCount": 123,
      "country": "abc123",
      "createdAt": "2007-12-03",
      "customFields": {},
      "disabled": true,
      "email": "abc123",
      "externalCustomerId": 4,
      "firstName": "abc123",
      "id": 4,
      "invitedByName": "abc123",
      "lang": "abc123",
      "lastActiveAt": "2007-12-03",
      "lastInitial": "abc123",
      "lastName": "xyz789",
      "learnerUserId": "4",
      "managerUserId": "4",
      "mustVerifyEmail": false,
      "name": "xyz789",
      "purchasedBundles": [PurchasedBundle],
      "purchasedCourses": [PurchasedCourse],
      "recommendedSlugs": [UserRecommendedSlug],
      "recommendedTags": [UserRecommendedTag],
      "ref1": "xyz789",
      "ref2": "xyz789",
      "ref3": "xyz789",
      "ref4": "abc123",
      "ref5": "xyz789",
      "ref6": "xyz789",
      "ref7": "xyz789",
      "ref8": "abc123",
      "ref9": "abc123",
      "ref10": "xyz789",
      "roleKey": "abc123",
      "sfAccountId": "4",
      "sfContactId": "4",
      "shippingName": "xyz789",
      "shouldHighlight": true,
      "startedCoursesCount": 987,
      "state": "abc123",
      "stripeCustomerId": "4",
      "telephone": "abc123",
      "twoFactorEnabled": true,
      "updatedAt": "2007-12-03",
      "waitlistedCourses": [WaitlistedCourse],
      "zipCode": "xyz789"
    }
  }
}

CurrentUserLearningPathMilestoneCompletionsBySlug

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [LearningPathAction]

Arguments
Name Description
slug - Slug!

Example

Query
query CurrentUserLearningPathMilestoneCompletionsBySlug($slug: Slug!) {
  CurrentUserLearningPathMilestoneCompletionsBySlug(slug: $slug) {
    id
    learningPath {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    milestone {
      completionCriteria {
        ...MilestoneCompletionCriteriaFragment
      }
      completionCriteriaDescription
      contentItems {
        ...ContentFragment
      }
      id
      kind
      learningPath {
        ...LearningPathFragment
      }
      milestoneCompetencyAssessment {
        ...MilestoneCompetencyAssessmentFragment
      }
      milestoneCourses {
        ...MilestoneCourseFragment
      }
      name
      releaseDate
      releaseDays
      requirement
    }
    source
    timestamp
    type
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"slug": Slug}
Response
{
  "data": {
    "CurrentUserLearningPathMilestoneCompletionsBySlug": [
      {
        "id": 4,
        "learningPath": "learning-path-1",
        "milestone": Milestone,
        "source": "xyz789",
        "timestamp": "2007-12-03",
        "type": "abc123",
        "user": User
      }
    ]
  }
}

Forums

Description

This query returns a forum containing discussion threads within a course, discussion widget, or assignment. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [Forum!]

Arguments
Name Description
clientId - ID The ID of the client.
courseId - ID! The ID of the course.

Example

Query
query Forums(
  $clientId: ID,
  $courseId: ID!
) {
  Forums(
    clientId: $clientId,
    courseId: $courseId
  ) {
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    id
    isGeneral
    label
    sectionId
    threadsCount
    updatedAt
  }
}
Variables
{"clientId": "4", "courseId": 4}
Response
{
  "data": {
    "Forums": [
      {
        "course": "course-1",
        "createdAt": "2007-12-03",
        "id": 4,
        "isGeneral": false,
        "label": "abc123",
        "sectionId": "4",
        "threadsCount": 987,
        "updatedAt": "2007-12-03"
      }
    ]
  }
}

HeliumDeploymentLog

Response

Returns a HeliumDeploymentLog!

Arguments
Name Description
filters - HeliumDeploymentLogFiltersInput
atomsStyleHash - String
jobId - ID! The ID of the Job.
key - String

Example

Query
query HeliumDeploymentLog(
  $filters: HeliumDeploymentLogFiltersInput,
  $atomsStyleHash: String,
  $jobId: ID!,
  $key: String
) {
  HeliumDeploymentLog(
    filters: $filters,
    atomsStyleHash: $atomsStyleHash,
    jobId: $jobId,
    key: $key
  ) {
    events {
      ingestionTime
      message
      timestamp
    }
    nextBackwardToken
    nextForwardToken
  }
}
Variables
{
  "filters": HeliumDeploymentLogFiltersInput,
  "atomsStyleHash": "xyz789",
  "jobId": 4,
  "key": "xyz789"
}
Response
{
  "data": {
    "HeliumDeploymentLog": {
      "events": [HeliumDeploymentLogEvent],
      "nextBackwardToken": "abc123",
      "nextForwardToken": "abc123"
    }
  }
}

Languages

Description

Returns array of Language objects configured in the Thought Industries instance

Response

Returns [Language!]!

Example

Query
query Languages {
  Languages {
    code
    id
    isCustom
    label
    selectorLabel
  }
}
Response
{
  "data": {
    "Languages": [
      {
        "code": "pt",
        "id": "builtin-pt",
        "isCustom": "false",
        "label": "Portuguese",
        "selectorLabel": "Português (Brasil)"
      }
    ]
  }
}

LearningPathBySlug

Description

Returns the learning path associated with the slug.

Response

Returns a LearningPath

Arguments
Name Description
slug - Slug! The slug for the Learning Path

Example

Query
query LearningPathBySlug($slug: Slug!) {
  LearningPathBySlug(slug: $slug) {
    accessDays
    alternativePricingRef
    alternativePricingType
    asset
    authors
    availabilityStatus
    bulkPurchasingEnabled
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    confirmationHtml
    contentType
    createdAt
    currentUserEarnedCertificate
    currentUserPendingCertificate
    currentUserStartActionDate
    customFields
    detailAsset
    endDate
    enrollmentEndDate
    enrollmentStartDate
    externalDetailUrl
    freeWithRegistration
    fulfillmentCenter
    futurePublishDate
    hasMultipleCurrencies
    heroAsset
    id
    isPayAsYouGo
    kind
    language
    lastTierPriceInCents
    layout {
      hasEnrollmentWidget
      id
      kind
      scripts
      widgets
    }
    layoutId
    learnerLayout {
      hasEnrollmentWidget
      id
      kind
      scripts
      widgets
    }
    learnerLayoutId
    longDescription
    metaDescription
    metaTitle
    milestones {
      completionCriteria {
        ...MilestoneCompletionCriteriaFragment
      }
      completionCriteriaDescription
      contentItems {
        ...ContentFragment
      }
      id
      kind
      learningPath {
        ...LearningPathFragment
      }
      milestoneCompetencyAssessment {
        ...MilestoneCompetencyAssessmentFragment
      }
      milestoneCourses {
        ...MilestoneCourseFragment
      }
      name
      releaseDate
      releaseDays
      requirement
    }
    name
    prerequisiteCourses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    prerequisiteLearningPaths {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    priceInCents
    prices {
      annualPriceInCents
      currencyCode
      id
      instructorAccessPriceInCents
      priceInCents
      suggestedRetailPriceInCents
      variations {
        ...ItemPriceVariationFragment
      }
    }
    publishDate
    purchasable
    relatedQuery
    relatedQuerySignature
    resourceType
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatPackages {
      seats
    }
    seatTiers {
      priceInCents
      seats
    }
    seatsLimit
    shortDescription
    sku
    slug
    source
    startDate
    status
    suggestedRetailPriceInCents
    tabs {
      generated
      id
      tabs {
        ...LearningPathTabFragment
      }
    }
    tags {
      id
      isFolder
      label
      updatedAt
    }
    taxCategory
    taxable
    updatedAt
    videoAsset
  }
}
Variables
{"slug": Slug}
Response
{
  "data": {
    "LearningPathBySlug": {
      "accessDays": 123,
      "alternativePricingRef": 987,
      "alternativePricingType": "membership",
      "asset": "http://www.test.com/",
      "authors": ["xyz789"],
      "availabilityStatus": "xyz789",
      "bulkPurchasingEnabled": false,
      "client": "client-1",
      "confirmationHtml": "xyz789",
      "contentType": "abc123",
      "createdAt": "2007-12-03",
      "currentUserEarnedCertificate": false,
      "currentUserPendingCertificate": false,
      "currentUserStartActionDate": "2007-12-03",
      "customFields": {},
      "detailAsset": "http://www.test.com/",
      "endDate": "2007-12-03",
      "enrollmentEndDate": "2007-12-03",
      "enrollmentStartDate": "2007-12-03",
      "externalDetailUrl": "abc123",
      "freeWithRegistration": false,
      "fulfillmentCenter": "4",
      "futurePublishDate": "2007-12-03",
      "hasMultipleCurrencies": false,
      "heroAsset": "http://www.test.com/",
      "id": 4,
      "isPayAsYouGo": false,
      "kind": "xyz789",
      "language": "abc123",
      "lastTierPriceInCents": 987,
      "layout": Layout,
      "layoutId": "4",
      "learnerLayout": Layout,
      "learnerLayoutId": 4,
      "longDescription": "xyz789",
      "metaDescription": "abc123",
      "metaTitle": "xyz789",
      "milestones": [Milestone],
      "name": "abc123",
      "prerequisiteCourses": [Course],
      "prerequisiteLearningPaths": [LearningPath],
      "priceInCents": 123,
      "prices": [ItemPrice],
      "publishDate": "2007-12-03",
      "purchasable": false,
      "relatedQuery": "abc123",
      "relatedQuerySignature": "abc123",
      "resourceType": "abc123",
      "ribbon": Ribbon,
      "seatPackages": [SeatPackage],
      "seatTiers": [SeatTier],
      "seatsLimit": 123,
      "shortDescription": "xyz789",
      "sku": "xyz789",
      "slug": Slug,
      "source": "xyz789",
      "startDate": "2007-12-03",
      "status": "archived",
      "suggestedRetailPriceInCents": 987,
      "tabs": LearningPathTabs,
      "tags": [Tag],
      "taxCategory": "4",
      "taxable": false,
      "updatedAt": "2007-12-03",
      "videoAsset": "4"
    }
  }
}

LearningPathCurrentUserAwardTotals

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [AwardTotal]

Arguments
Name Description
slug - Slug!

Example

Query
query LearningPathCurrentUserAwardTotals($slug: Slug!) {
  LearningPathCurrentUserAwardTotals(slug: $slug) {
    awardType {
      deleted
      icon
      id
      includeOnDashboard
      label
      pluralLabel
    }
    resource
    resourceId
    total
  }
}
Variables
{"slug": Slug}
Response
{
  "data": {
    "LearningPathCurrentUserAwardTotals": [
      {
        "awardType": AwardType,
        "resource": Course,
        "resourceId": 4,
        "total": 987.65
      }
    ]
  }
}

LoadAssessmentAttemptWithQuestions

Description

Returns an existing or new assessment attempt with questions. This is used when user starts a new assessment attempt, or resumes from an in-progress assessment attempt. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
assessmentAttemptId - ID The ID of the in-progress assessment attempt to resume from.
courseId - ID The ID of the Course.
id - ID! The ID of the Topic.
instructorAssessmentUserId - ID The ID of the user on behalf of whom the instructor takes the assessment.
linkedWorkbookId - ID The ID of the Linked Workbook.
shouldShuffleAndSubset - Boolean Flag to randomly order questions and choose a subset of questions to use.
topicType - AssessmentTopicType! The type of the Topic.

Example

Query
query LoadAssessmentAttemptWithQuestions(
  $assessmentAttemptId: ID,
  $courseId: ID,
  $id: ID!,
  $instructorAssessmentUserId: ID,
  $linkedWorkbookId: ID,
  $shouldShuffleAndSubset: Boolean,
  $topicType: AssessmentTopicType!
) {
  LoadAssessmentAttemptWithQuestions(
    assessmentAttemptId: $assessmentAttemptId,
    courseId: $courseId,
    id: $id,
    instructorAssessmentUserId: $instructorAssessmentUserId,
    linkedWorkbookId: $linkedWorkbookId,
    shouldShuffleAndSubset: $shouldShuffleAndSubset,
    topicType: $topicType
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "assessmentAttemptId": "4",
  "courseId": 4,
  "id": 4,
  "instructorAssessmentUserId": 4,
  "linkedWorkbookId": "4",
  "shouldShuffleAndSubset": true,
  "topicType": "quiz"
}
Response
{
  "data": {
    "LoadAssessmentAttemptWithQuestions": {
      "adminUpdatedGrade": false,
      "answeredQuestionsCount": 123,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": "4",
      "correctQuestionsCount": 987,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": true,
      "grade": 987,
      "id": 4,
      "linkedWorkbook": 4,
      "originalGrade": 987,
      "passed": false,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 123,
      "status": "finished",
      "timeElapsedInSeconds": 987,
      "topic": Topic,
      "topicId": "4",
      "topicType": "ad",
      "unansweredQuestionsCount": 123,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

LoadAssessmentAttemptsByTopicOrCourse

Description

Returns assessment attempts by course and/or topic. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [AssessmentAttempt!]!

Arguments
Name Description
courseId - ID The ID of the Course.
topicId - ID The ID of the Topic.

Example

Query
query LoadAssessmentAttemptsByTopicOrCourse(
  $courseId: ID,
  $topicId: ID
) {
  LoadAssessmentAttemptsByTopicOrCourse(
    courseId: $courseId,
    topicId: $topicId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"courseId": 4, "topicId": "4"}
Response
{
  "data": {
    "LoadAssessmentAttemptsByTopicOrCourse": [
      {
        "adminUpdatedGrade": false,
        "answeredQuestionsCount": 123,
        "answers": [AssessmentAnswer],
        "assessment": Assessment,
        "assignmentSubmissionId": "4",
        "correctQuestionsCount": 123,
        "course": "course-1",
        "courseId": "course-1",
        "createdAt": "2007-12-03",
        "forgiven": true,
        "grade": 123,
        "id": 4,
        "linkedWorkbook": "4",
        "originalGrade": 987,
        "passed": false,
        "poolLabelByQuestionId": {},
        "questions": [QuizQuestion],
        "questionsWithChoicesCount": 987,
        "status": "finished",
        "timeElapsedInSeconds": 987,
        "topic": Topic,
        "topicId": 4,
        "topicType": "ad",
        "unansweredQuestionsCount": 123,
        "updatedAt": "2007-12-03",
        "user": User
      }
    ]
  }
}

LoadSuperQuizInfo

Description

This query loads quiz questions and other data about the entered quiz(s). This query allows you to fetch questions for multiple quizzes at the same time. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a SuperQuiz!

Arguments
Name Description
courseId - ID The ID of the Course.
includeCorrectAnswers - Boolean Flag to include questions the user previously got correct.
quizzes - [ID!]! The IDs of the Quizzes user selects.

Example

Query
query LoadSuperQuizInfo(
  $courseId: ID,
  $includeCorrectAnswers: Boolean,
  $quizzes: [ID!]!
) {
  LoadSuperQuizInfo(
    courseId: $courseId,
    includeCorrectAnswers: $includeCorrectAnswers,
    quizzes: $quizzes
  ) {
    displayAllHints
    navigationDisabled
    questionSkipEnabled
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    quizzes
    timePerQuestionInSeconds
    timerEnabled
    totalTimeInSeconds
  }
}
Variables
{
  "courseId": "4",
  "includeCorrectAnswers": true,
  "quizzes": ["4"]
}
Response
{
  "data": {
    "LoadSuperQuizInfo": {
      "displayAllHints": false,
      "navigationDisabled": true,
      "questionSkipEnabled": false,
      "questions": [QuizQuestion],
      "quizzes": [4],
      "timePerQuestionInSeconds": 987,
      "timerEnabled": true,
      "totalTimeInSeconds": 987
    }
  }
}

Milestone

Response

Returns a Milestone

Arguments
Name Description
id - ID!

Example

Query
query Milestone($id: ID!) {
  Milestone(id: $id) {
    completionCriteria {
      awardType {
        ...AwardTypeFragment
      }
      id
      threshold
      type
    }
    completionCriteriaDescription
    contentItems {
      acceptBadgeUrl
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      badgeName
      badgeUrl
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      credlyBadgeExpiresAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      enrollmentEndDate
      enrollmentStartDate
      expiresAt
      hasChildren
      hideCourseDescription
      id
      imageUrl
      isActive
      issuedAt
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      state
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    id
    kind
    learningPath {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    milestoneCompetencyAssessment {
      allowRetakes
      asset
      buttonText
      competencyAssessment {
        ...CompetencyAssessmentFragment
      }
      competencyAssessmentId
      displayType
      id
      largeAsset
      passingScoreRequired
      requirement
      smallAsset
      subtitle
      title
      type
    }
    milestoneCourses {
      altDescriptionBody
      contentGrouping
      contentId
      contentTitle
      hideCourseDescription
      id
      requirement
    }
    name
    releaseDate
    releaseDays
    requirement
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "Milestone": {
      "completionCriteria": [MilestoneCompletionCriteria],
      "completionCriteriaDescription": "abc123",
      "contentItems": [Content],
      "id": 4,
      "kind": "competencyAssessment",
      "learningPath": "learning-path-1",
      "milestoneCompetencyAssessment": MilestoneCompetencyAssessment,
      "milestoneCourses": [MilestoneCourse],
      "name": "xyz789",
      "releaseDate": "2007-12-03",
      "releaseDays": 123,
      "requirement": "elective"
    }
  }
}

Pages

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Milestone

Arguments
Name Description
id - ID!

Example

Query
query Pages($id: ID!) {
  Pages(id: $id) {
    completionCriteria {
      awardType {
        ...AwardTypeFragment
      }
      id
      threshold
      type
    }
    completionCriteriaDescription
    contentItems {
      acceptBadgeUrl
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      badgeName
      badgeUrl
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      credlyBadgeExpiresAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      enrollmentEndDate
      enrollmentStartDate
      expiresAt
      hasChildren
      hideCourseDescription
      id
      imageUrl
      isActive
      issuedAt
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      state
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    id
    kind
    learningPath {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    milestoneCompetencyAssessment {
      allowRetakes
      asset
      buttonText
      competencyAssessment {
        ...CompetencyAssessmentFragment
      }
      competencyAssessmentId
      displayType
      id
      largeAsset
      passingScoreRequired
      requirement
      smallAsset
      subtitle
      title
      type
    }
    milestoneCourses {
      altDescriptionBody
      contentGrouping
      contentId
      contentTitle
      hideCourseDescription
      id
      requirement
    }
    name
    releaseDate
    releaseDays
    requirement
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "Pages": {
      "completionCriteria": [MilestoneCompletionCriteria],
      "completionCriteriaDescription": "abc123",
      "contentItems": [Content],
      "id": 4,
      "kind": "competencyAssessment",
      "learningPath": "learning-path-1",
      "milestoneCompetencyAssessment": MilestoneCompetencyAssessment,
      "milestoneCourses": [MilestoneCourse],
      "name": "abc123",
      "releaseDate": "2007-12-03",
      "releaseDays": 987,
      "requirement": "elective"
    }
  }
}

Pages

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [PageResource]!

Arguments
Name Description
identifiers - [String!]!

Example

Query
query Pages($identifiers: [String!]!) {
  Pages(identifiers: $identifiers)
}
Variables
{"identifiers": ["abc123"]}
Response
{"data": {"Pages": [ArticlePage]}}

PagesCompletedByCourse

Description

Returns completed pages within a course. The results of this query can be affected by providing an authToken header to set a user for the operation. This query has an additional cost of 3 points.

Response

Returns [PageResource!]!

Arguments
Name Description
courseId - ID! The ID of the Course.

Example

Query
query PagesCompletedByCourse($courseId: ID!) {
  PagesCompletedByCourse(courseId: $courseId)
}
Variables
{"courseId": "4"}
Response
{"data": {"PagesCompletedByCourse": [ArticlePage]}}

QueryContents

Description

This query has an additional cost of 3 points.

Response

Returns [Content!]!

Arguments
Name Description
ids - [ID!]!

Example

Query
query QueryContents($ids: [ID!]!) {
  QueryContents(ids: $ids) {
    acceptBadgeUrl
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    badgeName
    badgeUrl
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    credlyBadgeExpiresAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    enrollmentEndDate
    enrollmentStartDate
    expiresAt
    hasChildren
    hideCourseDescription
    id
    imageUrl
    isActive
    issuedAt
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    state
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Variables
{"ids": ["4"]}
Response
{
  "data": {
    "QueryContents": [
      {
        "acceptBadgeUrl": "abc123",
        "altDescriptionBody": "xyz789",
        "alternativePricingRef": 987,
        "alternativePricingType": "membership",
        "asset": "xyz789",
        "authors": ["xyz789"],
        "authorsAndInstructors": ["abc123"],
        "availabilityStatus": "abc123",
        "badgeName": "xyz789",
        "badgeUrl": "xyz789",
        "bulkPurchasingEnabled": true,
        "canAddToQueue": false,
        "contentTypeAssetAspectRatio": "abc123",
        "contentTypeLabel": "xyz789",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": false,
        "courseGroup": "courseGroup-1",
        "coursePresold": false,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "credlyBadgeExpiresAt": "2007-12-03",
        "currentUserMayReschedule": true,
        "currentUserUnmetCoursePrerequisites": [4],
        "currentUserUnmetLearningPathPrerequisites": [
          "4"
        ],
        "customFields": {},
        "description": "xyz789",
        "displayCourse": "4",
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": true,
        "enrollmentCount": 987,
        "enrollmentEndDate": "2007-12-03",
        "enrollmentStartDate": "2007-12-03",
        "expiresAt": "2007-12-03",
        "hasChildren": true,
        "hideCourseDescription": true,
        "id": "4",
        "imageUrl": "abc123",
        "isActive": true,
        "issuedAt": "2007-12-03",
        "kind": "article",
        "language": "xyz789",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "abc123",
        "metaTitle": "xyz789",
        "priceInCents": 987,
        "publishDate": "2007-12-03",
        "rating": 123,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "xyz789",
        "sku": "abc123",
        "slug": Slug,
        "source": "xyz789",
        "state": "abc123",
        "status": "archived",
        "suggestedRetailPriceInCents": 123,
        "tags": [Tag],
        "timeZone": "xyz789",
        "title": "xyz789",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 123,
        "waitlistingEnabled": true,
        "waitlistingTriggered": true
      }
    ]
  }
}

RelatedProducts

Response

Returns [Product!]!

Arguments
Name Description
courseIds - [ID!]!
productIds - [ID!]!

Example

Query
query RelatedProducts(
  $courseIds: [ID!]!,
  $productIds: [ID!]!
) {
  RelatedProducts(
    courseIds: $courseIds,
    productIds: $productIds
  ) {
    alternativePricingRef
    alternativePricingType
    asset
    id
    language
    longDescription
    name
    priceInCents
    purchasable
    relatedProducts {
      alternativePricingRef
      alternativePricingType
      asset
      id
      language
      longDescription
      name
      priceInCents
      purchasable
      relatedProducts {
        ...ProductFragment
      }
      status
      suggestedRetailPriceInCents
    }
    status
    suggestedRetailPriceInCents
  }
}
Variables
{"courseIds": [4], "productIds": ["4"]}
Response
{
  "data": {
    "RelatedProducts": [
      {
        "alternativePricingRef": 123,
        "alternativePricingType": "membership",
        "asset": "http://www.test.com/",
        "id": 4,
        "language": "xyz789",
        "longDescription": "abc123",
        "name": "xyz789",
        "priceInCents": 987,
        "purchasable": false,
        "relatedProducts": [Product],
        "status": "archived",
        "suggestedRetailPriceInCents": 987
      }
    ]
  }
}

RssItems

Response

Returns [RssItem!]!

Arguments
Name Description
feedUrl - String!

Example

Query
query RssItems($feedUrl: String!) {
  RssItems(feedUrl: $feedUrl) {
    author
    categories
    date
    description
    id
    imageAltTitle
    imageUrl
    link
    title
  }
}
Variables
{"feedUrl": "xyz789"}
Response
{
  "data": {
    "RssItems": [
      {
        "author": "xyz789",
        "categories": ["abc123"],
        "date": "2007-12-03",
        "description": "xyz789",
        "id": 4,
        "imageAltTitle": "xyz789",
        "imageUrl": "abc123",
        "link": "abc123",
        "title": "xyz789"
      }
    ]
  }
}

RusticiLaunchScorm

Description

Returns data to launch SCORM content through Rustici API.

Response

Returns a RusticiCourseLaunchResponse!

Arguments
Name Description
isPreview - Boolean! Requests the preview URL to launch SCORM content. This requires the current user to be in admin or manager role.
topicOrCourseId - ID! The ID of the Topic Or Course.
type - ContentOrTopicEnum The type of the Topic Or Course.

Example

Query
query RusticiLaunchScorm(
  $isPreview: Boolean!,
  $topicOrCourseId: ID!,
  $type: ContentOrTopicEnum
) {
  RusticiLaunchScorm(
    isPreview: $isPreview,
    topicOrCourseId: $topicOrCourseId,
    type: $type
  ) {
    courseTitle
    fullscreenEmbed
    height
    isRusticiCourse
    registrationCheckerEndpoint
    registrationCheckerJWT
    registrationId
    url
    width
  }
}
Variables
{"isPreview": true, "topicOrCourseId": 4, "type": "course"}
Response
{
  "data": {
    "RusticiLaunchScorm": {
      "courseTitle": "xyz789",
      "fullscreenEmbed": false,
      "height": 123,
      "isRusticiCourse": true,
      "registrationCheckerEndpoint": "http://www.test.com/",
      "registrationCheckerJWT": "xyz789",
      "registrationId": 4,
      "url": AbsoluteOrRelativeURL,
      "width": 987
    }
  }
}

SearchThreads

Description

This query returns a list of threads based on a search query provided. It also only works for widet threads. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a ThreadsList!

Arguments
Name Description
clientId - ID The ID of the client.
page - Int! The page number to return within the collection.
perPage - Int! The amount of items to be returned on the page.
query - String The search query used to return the list of threads.
sort - String! How the items are to be sorted.
widgetForumId - ID! The ID of the Widget Forum.

Example

Query
query SearchThreads(
  $clientId: ID,
  $page: Int!,
  $perPage: Int!,
  $query: String,
  $sort: String!,
  $widgetForumId: ID!
) {
  SearchThreads(
    clientId: $clientId,
    page: $page,
    perPage: $perPage,
    query: $query,
    sort: $sort,
    widgetForumId: $widgetForumId
  ) {
    discussionRules
    pageInfo {
      currentPage
      hasMore
      perPage
      total
    }
    threads {
      asset
      assetFileName
      body
      bookmark
      client {
        ...ClientFragment
      }
      commentsCount
      course {
        ...CourseFragment
      }
      createdAt
      forum {
        ...ForumFragment
      }
      forumId
      id
      matchCount
      notificationsEnabled
      title
      updatedAt
      user {
        ...UserFragment
      }
      videoAsset
    }
  }
}
Variables
{
  "clientId": "4",
  "page": 123,
  "perPage": 987,
  "query": "xyz789",
  "sort": "abc123",
  "widgetForumId": "4"
}
Response
{
  "data": {
    "SearchThreads": {
      "discussionRules": "abc123",
      "pageInfo": PageInfo,
      "threads": [Thread]
    }
  }
}

TermsAndConditions

Response

Returns a TermsAndConditions!

Example

Query
query TermsAndConditions {
  TermsAndConditions {
    globalTerms
  }
}
Response
{
  "data": {
    "TermsAndConditions": {
      "globalTerms": "xyz789"
    }
  }
}

ThreadById

Description

This query returns a thread based on the ID provided. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Thread

Arguments
Name Description
clientId - ID The ID of the client.
commentableType - CommentableType The type of thread requested, based on the forum's location, e.g. discussion board, assignment, widget thread etc.
forumId - ID The ID of the Forum.
id - ID! The ID of the thread.

Example

Query
query ThreadById(
  $clientId: ID,
  $commentableType: CommentableType,
  $forumId: ID,
  $id: ID!
) {
  ThreadById(
    clientId: $clientId,
    commentableType: $commentableType,
    forumId: $forumId,
    id: $id
  ) {
    asset
    assetFileName
    body
    bookmark
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    commentsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    forum {
      course {
        ...CourseFragment
      }
      createdAt
      id
      isGeneral
      label
      sectionId
      threadsCount
      updatedAt
    }
    forumId
    id
    matchCount
    notificationsEnabled
    title
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
    videoAsset
  }
}
Variables
{
  "clientId": "4",
  "commentableType": "assignment",
  "forumId": "4",
  "id": 4
}
Response
{
  "data": {
    "ThreadById": {
      "asset": "http://www.test.com/",
      "assetFileName": "abc123",
      "body": "xyz789",
      "bookmark": "4",
      "client": "client-1",
      "commentsCount": 123,
      "course": "course-1",
      "createdAt": "2007-12-03",
      "forum": Forum,
      "forumId": 4,
      "id": "4",
      "matchCount": 987,
      "notificationsEnabled": true,
      "title": "abc123",
      "updatedAt": "2007-12-03",
      "user": User,
      "videoAsset": 4
    }
  }
}

Threads

Description

This query returns a list of threads. The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns a ThreadsList

Arguments
Name Description
clientId - ID The ID of the client.
commentableType - CommentableType The type of thread requested, based on the forum's location, e.g. discussion board, assignment, widget thread etc
courseId - ID The ID of the course.
forumId - ID! The ID of the forum.
page - Int The page number to return within the collection.
perPage - Int The amount of items to be returned on the page.

Example

Query
query Threads(
  $clientId: ID,
  $commentableType: CommentableType,
  $courseId: ID,
  $forumId: ID!,
  $page: Int,
  $perPage: Int
) {
  Threads(
    clientId: $clientId,
    commentableType: $commentableType,
    courseId: $courseId,
    forumId: $forumId,
    page: $page,
    perPage: $perPage
  ) {
    discussionRules
    pageInfo {
      currentPage
      hasMore
      perPage
      total
    }
    threads {
      asset
      assetFileName
      body
      bookmark
      client {
        ...ClientFragment
      }
      commentsCount
      course {
        ...CourseFragment
      }
      createdAt
      forum {
        ...ForumFragment
      }
      forumId
      id
      matchCount
      notificationsEnabled
      title
      updatedAt
      user {
        ...UserFragment
      }
      videoAsset
    }
  }
}
Variables
{
  "clientId": "4",
  "commentableType": "assignment",
  "courseId": "4",
  "forumId": "4",
  "page": 987,
  "perPage": 987
}
Response
{
  "data": {
    "Threads": {
      "discussionRules": "xyz789",
      "pageInfo": PageInfo,
      "threads": [Thread]
    }
  }
}

UserArchives

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [ArchivedContent!]

Example

Query
query UserArchives {
  UserArchives {
    archivedAt
    company {
      appearanceSettings {
        ...AppearanceSettingsFragment
      }
      catalogBlock {
        ...BlockFragment
      }
      catalogVisibilityEmails
      copyrightName
      id
      micrositeFooter {
        ...MicrositeBlockFragment
      }
      micrositeHeader {
        ...MicrositeBlockFragment
      }
      name
      organization {
        ...OrganizationFragment
      }
      rootLayout {
        ...RootLayoutFragment
      }
      schoolName
      subdomain
    }
    id
    name
    reinstatable
    resource
    resourceType
    status
    user
    waitlistActive
  }
}
Response
{
  "data": {
    "UserArchives": [
      {
        "archivedAt": "2007-12-03",
        "company": Company,
        "id": "4",
        "name": "abc123",
        "reinstatable": false,
        "resource": 4,
        "resourceType": "xyz789",
        "status": "abc123",
        "user": 4,
        "waitlistActive": false
      }
    ]
  }
}

UserBookmarks

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [BookmarkFolder!]

Example

Query
query UserBookmarks {
  UserBookmarks {
    bookmarkCount
    bookmarks {
      bookmarkFolder {
        ...BookmarkFolderFragment
      }
      course {
        ...CourseFragment
      }
      createdAt
      deleted
      id
      note
      topic {
        ...TopicFragment
      }
      topicId
      user {
        ...UserFragment
      }
    }
    defaultFolder
    deleted
    externalResourceId
    id
    name
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Response
{
  "data": {
    "UserBookmarks": [
      {
        "bookmarkCount": 987,
        "bookmarks": [Bookmark],
        "defaultFolder": true,
        "deleted": true,
        "externalResourceId": 4,
        "id": 4,
        "name": "abc123",
        "user": User
      }
    ]
  }
}

UserBookmarksByFolder

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [Bookmark!]

Arguments
Name Description
id - ID!

Example

Query
query UserBookmarksByFolder($id: ID!) {
  UserBookmarksByFolder(id: $id) {
    bookmarkFolder {
      bookmarkCount
      bookmarks {
        ...BookmarkFragment
      }
      defaultFolder
      deleted
      externalResourceId
      id
      name
      user {
        ...UserFragment
      }
    }
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    deleted
    id
    note
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "UserBookmarksByFolder": [
      {
        "bookmarkFolder": BookmarkFolder,
        "course": "course-1",
        "createdAt": "2007-12-03",
        "deleted": true,
        "id": 4,
        "note": "xyz789",
        "topic": Topic,
        "topicId": "4",
        "user": User
      }
    ]
  }
}

UserCertificateFields

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [CertificateField!]

Example

Query
query UserCertificateFields {
  UserCertificateFields {
    awardType {
      deleted
      icon
      id
      includeOnDashboard
      label
      pluralLabel
    }
    awardTypeId
    customField {
      id
      includeLabelOnContent
      includeValueOnContent
      indexed
      label
      multiple
      slug
      sort
    }
    customFieldSlug
    dateFormat
    hasIdentifierPrefix
    id
    identifierBodyLength
    identifierPrefix
    includeOnExternalCertificate
    includeOnTranscript
    label
    sessionCustomContentFieldSlug
    text
    type
    userCustomField {
      choices
      id
      label
      ref
      required
      slug
      type
    }
    userCustomFieldSlug
  }
}
Response
{
  "data": {
    "UserCertificateFields": [
      {
        "awardType": AwardType,
        "awardTypeId": "4",
        "customField": CustomField,
        "customFieldSlug": Slug,
        "dateFormat": "euroShort",
        "hasIdentifierPrefix": true,
        "id": 4,
        "identifierBodyLength": 123,
        "identifierPrefix": "xyz789",
        "includeOnExternalCertificate": false,
        "includeOnTranscript": false,
        "label": "xyz789",
        "sessionCustomContentFieldSlug": Slug,
        "text": "xyz789",
        "type": "awardLabel",
        "userCustomField": UserCustomField,
        "userCustomFieldSlug": Slug
      }
    ]
  }
}

UserCertificates

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [Certificate]

Arguments
Name Description
includeExpiredCertificates - Boolean
query - String

Example

Query
query UserCertificates(
  $includeExpiredCertificates: Boolean,
  $query: String
) {
  UserCertificates(
    includeExpiredCertificates: $includeExpiredCertificates,
    query: $query
  ) {
    certificateTemplate {
      asset
      assetLibraryId
      customCss
      expirationDate
      expirationDays
      id
      isExpired
      labels {
        ...CertificateTemplateLabelFragment
      }
      recertificationAction
      recertificationActionText
      recertificationActionUrl
      recertificationAfterDays
      recertificationAutoReset
      recertificationInstructions
      resource
      resourceType
      supplementalAssets
      title
      userCustomField {
        ...UserCustomFieldFragment
      }
      userCustomFieldSlug
      userCustomFieldValue
    }
    contentItem {
      acceptBadgeUrl
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      badgeName
      badgeUrl
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      credlyBadgeExpiresAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      enrollmentEndDate
      enrollmentStartDate
      expiresAt
      hasChildren
      hideCourseDescription
      id
      imageUrl
      isActive
      issuedAt
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      state
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    deleted
    didExpire
    expirationDate
    externalResourceTitle
    id
    identifier
    isExpired
    isExternal
    issuedAt
    pdfAsset
    progressWasReset
    recertificationDate
    resource
    resourceId
    resourceType
    resourceTypeLabel
    source
    url
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "includeExpiredCertificates": false,
  "query": "abc123"
}
Response
{
  "data": {
    "UserCertificates": [
      {
        "certificateTemplate": CertificateTemplate,
        "contentItem": Content,
        "deleted": false,
        "didExpire": false,
        "expirationDate": "2007-12-03",
        "externalResourceTitle": "abc123",
        "id": "4",
        "identifier": "xyz789",
        "isExpired": true,
        "isExternal": false,
        "issuedAt": "2007-12-03",
        "pdfAsset": AbsoluteOrRelativeURL,
        "progressWasReset": false,
        "recertificationDate": "2007-12-03",
        "resource": Course,
        "resourceId": 4,
        "resourceType": "course",
        "resourceTypeLabel": "abc123",
        "source": "abc123",
        "url": AbsoluteOrRelativeURL,
        "user": User
      }
    ]
  }
}

UserContentGroups

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [ContentGroup!]

Arguments
Name Description
includeExpiredCertificates - Boolean
query - String

Example

Query
query UserContentGroups(
  $includeExpiredCertificates: Boolean,
  $query: String
) {
  UserContentGroups(
    includeExpiredCertificates: $includeExpiredCertificates,
    query: $query
  ) {
    count
    kind
  }
}
Variables
{
  "includeExpiredCertificates": true,
  "query": "xyz789"
}
Response
{
  "data": {
    "UserContentGroups": [{"count": 987, "kind": "archivedContentItems"}]
  }
}

UserContentItems

Description

The results of this query can be affected by providing an authToken header to set a user for the operation. This query has an additional cost of 3 points.

Response

Returns [Content!]

Arguments
Name Description
kind - [ContentKind!]
query - String
sortColumn - SortColumn
sortDirection - SortDirection

Example

Query
query UserContentItems(
  $kind: [ContentKind!],
  $query: String,
  $sortColumn: SortColumn,
  $sortDirection: SortDirection
) {
  UserContentItems(
    kind: $kind,
    query: $query,
    sortColumn: $sortColumn,
    sortDirection: $sortDirection
  ) {
    acceptBadgeUrl
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    badgeName
    badgeUrl
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    credlyBadgeExpiresAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    enrollmentEndDate
    enrollmentStartDate
    expiresAt
    hasChildren
    hideCourseDescription
    id
    imageUrl
    isActive
    issuedAt
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    state
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Variables
{
  "kind": ["article"],
  "query": "abc123",
  "sortColumn": "courseStartDate",
  "sortDirection": "asc"
}
Response
{
  "data": {
    "UserContentItems": [
      {
        "acceptBadgeUrl": "xyz789",
        "altDescriptionBody": "abc123",
        "alternativePricingRef": 123,
        "alternativePricingType": "membership",
        "asset": "abc123",
        "authors": ["xyz789"],
        "authorsAndInstructors": ["xyz789"],
        "availabilityStatus": "xyz789",
        "badgeName": "xyz789",
        "badgeUrl": "abc123",
        "bulkPurchasingEnabled": true,
        "canAddToQueue": true,
        "contentTypeAssetAspectRatio": "xyz789",
        "contentTypeLabel": "xyz789",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": false,
        "courseGroup": "courseGroup-1",
        "coursePresold": true,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "credlyBadgeExpiresAt": "2007-12-03",
        "currentUserMayReschedule": true,
        "currentUserUnmetCoursePrerequisites": [
          "4"
        ],
        "currentUserUnmetLearningPathPrerequisites": [
          "4"
        ],
        "customFields": {},
        "description": "abc123",
        "displayCourse": "4",
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": true,
        "enrollmentCount": 123,
        "enrollmentEndDate": "2007-12-03",
        "enrollmentStartDate": "2007-12-03",
        "expiresAt": "2007-12-03",
        "hasChildren": false,
        "hideCourseDescription": true,
        "id": "4",
        "imageUrl": "abc123",
        "isActive": true,
        "issuedAt": "2007-12-03",
        "kind": "article",
        "language": "xyz789",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "abc123",
        "metaTitle": "abc123",
        "priceInCents": 987,
        "publishDate": "2007-12-03",
        "rating": 987,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "abc123",
        "sku": "xyz789",
        "slug": Slug,
        "source": "xyz789",
        "state": "xyz789",
        "status": "archived",
        "suggestedRetailPriceInCents": 123,
        "tags": [Tag],
        "timeZone": "abc123",
        "title": "abc123",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 987,
        "waitlistingEnabled": false,
        "waitlistingTriggered": true
      }
    ]
  }
}

UserCourseAwardCounts

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [UserAwardCount!]!

Arguments
Name Description
courseId - ID! The ID of the Course.

Example

Query
query UserCourseAwardCounts($courseId: ID!) {
  UserCourseAwardCounts(courseId: $courseId) {
    count
    icon
    id
    label
  }
}
Variables
{"courseId": "4"}
Response
{
  "data": {
    "UserCourseAwardCounts": [
      {
        "count": 123,
        "icon": "businessuser",
        "id": 4,
        "label": "xyz789"
      }
    ]
  }
}

UserCourseCollaborations

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns an Int!

Arguments
Name Description
courseId - ID! The ID of the Course.

Example

Query
query UserCourseCollaborations($courseId: ID!) {
  UserCourseCollaborations(courseId: $courseId)
}
Variables
{"courseId": "4"}
Response
{"data": {"UserCourseCollaborations": 987}}

UserCourseCompletionProgress

Description

The results of this query can be affected by providing an authToken header to set a user for the operation. This query has an additional cost of 5 points.

Arguments
Name Description
id - ID!

Example

Query
query UserCourseCompletionProgress($id: ID!) {
  UserCourseCompletionProgress(id: $id) {
    completed
    percent
    required
    type
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "UserCourseCompletionProgress": [
      {
        "completed": [4],
        "percent": 123,
        "required": [4],
        "type": "articlePercentViewed"
      }
    ]
  }
}

UserCourseProgress

Description

The results of this query can be affected by providing an authToken header to set a user for the operation. This query has an additional cost of 5 points.

Response

Returns a UserProgress

Arguments
Name Description
id - ID!

Example

Query
query UserCourseProgress($id: ID!) {
  UserCourseProgress(id: $id) {
    percentComplete
    totalTime
    totalViews
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "UserCourseProgress": {
      "percentComplete": 987,
      "totalTime": 987,
      "totalViews": 123
    }
  }
}

UserEarnedBadgeBoard

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns an EarnedBadgeBoard!

Example

Query
query UserEarnedBadgeBoard {
  UserEarnedBadgeBoard {
    earnedBadges {
      badge {
        ...BadgeFragment
      }
      deleted
      id
      user {
        ...UserFragment
      }
    }
    unearnedBadges {
      asset
      awardThreshold
      awardType {
        ...AwardTypeFragment
      }
      deleted
      id
      label
    }
  }
}
Response
{
  "data": {
    "UserEarnedBadgeBoard": {
      "earnedBadges": [EarnedBadge],
      "unearnedBadges": [Badge]
    }
  }
}

UserRecentContent

Description

The results of this query can be affected by providing an authToken header to set a user for the operation. This query has an additional cost of 4 points.

Response

Returns [Content!]!

Arguments
Name Description
limit - Int

Example

Query
query UserRecentContent($limit: Int) {
  UserRecentContent(limit: $limit) {
    acceptBadgeUrl
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    badgeName
    badgeUrl
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    credlyBadgeExpiresAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    enrollmentEndDate
    enrollmentStartDate
    expiresAt
    hasChildren
    hideCourseDescription
    id
    imageUrl
    isActive
    issuedAt
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    state
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Variables
{"limit": 987}
Response
{
  "data": {
    "UserRecentContent": [
      {
        "acceptBadgeUrl": "xyz789",
        "altDescriptionBody": "abc123",
        "alternativePricingRef": 123,
        "alternativePricingType": "membership",
        "asset": "abc123",
        "authors": ["xyz789"],
        "authorsAndInstructors": ["abc123"],
        "availabilityStatus": "abc123",
        "badgeName": "abc123",
        "badgeUrl": "abc123",
        "bulkPurchasingEnabled": false,
        "canAddToQueue": true,
        "contentTypeAssetAspectRatio": "xyz789",
        "contentTypeLabel": "abc123",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": true,
        "courseGroup": "courseGroup-1",
        "coursePresold": false,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "credlyBadgeExpiresAt": "2007-12-03",
        "currentUserMayReschedule": true,
        "currentUserUnmetCoursePrerequisites": [4],
        "currentUserUnmetLearningPathPrerequisites": [4],
        "customFields": {},
        "description": "abc123",
        "displayCourse": "4",
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": true,
        "enrollmentCount": 987,
        "enrollmentEndDate": "2007-12-03",
        "enrollmentStartDate": "2007-12-03",
        "expiresAt": "2007-12-03",
        "hasChildren": true,
        "hideCourseDescription": true,
        "id": 4,
        "imageUrl": "xyz789",
        "isActive": false,
        "issuedAt": "2007-12-03",
        "kind": "article",
        "language": "abc123",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "abc123",
        "metaTitle": "xyz789",
        "priceInCents": 123,
        "publishDate": "2007-12-03",
        "rating": 987,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "abc123",
        "sku": "xyz789",
        "slug": Slug,
        "source": "abc123",
        "state": "abc123",
        "status": "archived",
        "suggestedRetailPriceInCents": 987,
        "tags": [Tag],
        "timeZone": "xyz789",
        "title": "abc123",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 123,
        "waitlistingEnabled": true,
        "waitlistingTriggered": true
      }
    ]
  }
}

UserWaitlist

Description

The results of this query can be affected by providing an authToken header to set a user for the operation.

Response

Returns [Content!]

Example

Query
query UserWaitlist {
  UserWaitlist {
    acceptBadgeUrl
    altDescriptionBody
    alternativePricingRef
    alternativePricingType
    asset
    authors
    authorsAndInstructors
    availabilityStatus
    badgeName
    badgeUrl
    bulkPurchasingEnabled
    canAddToQueue
    contentTypeAssetAspectRatio
    contentTypeLabel
    courseEndDate
    courseGracePeriodEnded
    courseGroup
    coursePresold
    courseStartDate
    createdAt
    credlyBadgeExpiresAt
    currentUserMayReschedule
    currentUserUnmetCoursePrerequisites
    currentUserUnmetLearningPathPrerequisites
    customFields
    description
    displayCourse
    displayCourseSlug
    displayDate
    embeddedEnabled
    enrollmentCount
    enrollmentEndDate
    enrollmentStartDate
    expiresAt
    hasChildren
    hideCourseDescription
    id
    imageUrl
    isActive
    issuedAt
    kind
    language
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetingStartDate
    metaDescription
    metaTitle
    priceInCents
    publishDate
    rating
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatsLimit
    sessionTitle
    sku
    slug
    source
    state
    status
    suggestedRetailPriceInCents
    tags {
      id
      isFolder
      label
      updatedAt
    }
    timeZone
    title
    updatedAt
    url
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
  }
}
Response
{
  "data": {
    "UserWaitlist": [
      {
        "acceptBadgeUrl": "abc123",
        "altDescriptionBody": "xyz789",
        "alternativePricingRef": 123,
        "alternativePricingType": "membership",
        "asset": "xyz789",
        "authors": ["xyz789"],
        "authorsAndInstructors": ["xyz789"],
        "availabilityStatus": "xyz789",
        "badgeName": "abc123",
        "badgeUrl": "abc123",
        "bulkPurchasingEnabled": true,
        "canAddToQueue": true,
        "contentTypeAssetAspectRatio": "abc123",
        "contentTypeLabel": "abc123",
        "courseEndDate": "2007-12-03",
        "courseGracePeriodEnded": false,
        "courseGroup": "courseGroup-1",
        "coursePresold": true,
        "courseStartDate": "2007-12-03",
        "createdAt": "2007-12-03",
        "credlyBadgeExpiresAt": "2007-12-03",
        "currentUserMayReschedule": true,
        "currentUserUnmetCoursePrerequisites": [4],
        "currentUserUnmetLearningPathPrerequisites": [4],
        "customFields": {},
        "description": "abc123",
        "displayCourse": "4",
        "displayCourseSlug": Slug,
        "displayDate": "2007-12-03",
        "embeddedEnabled": false,
        "enrollmentCount": 123,
        "enrollmentEndDate": "2007-12-03",
        "enrollmentStartDate": "2007-12-03",
        "expiresAt": "2007-12-03",
        "hasChildren": true,
        "hideCourseDescription": true,
        "id": "4",
        "imageUrl": "xyz789",
        "isActive": true,
        "issuedAt": "2007-12-03",
        "kind": "article",
        "language": "abc123",
        "location": Location,
        "meetingStartDate": "2007-12-03",
        "metaDescription": "xyz789",
        "metaTitle": "xyz789",
        "priceInCents": 987,
        "publishDate": "2007-12-03",
        "rating": 123,
        "ribbon": Ribbon,
        "seatsLimit": 987,
        "sessionTitle": "xyz789",
        "sku": "xyz789",
        "slug": Slug,
        "source": "abc123",
        "state": "abc123",
        "status": "archived",
        "suggestedRetailPriceInCents": 987,
        "tags": [Tag],
        "timeZone": "xyz789",
        "title": "abc123",
        "updatedAt": "2007-12-03",
        "url": AbsoluteOrRelativeURL,
        "waitlistCount": 123,
        "waitlistingEnabled": true,
        "waitlistingTriggered": false
      }
    ]
  }
}

Mutations

AddResourceToQueue

Description

Adds a resource to the queue of content for the current user so it can be viewed at a later time. Returns true if the content has been successfully added. The user must be given access to the course before it can be added to their queue. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Boolean!

Arguments
Name Description
resourceId - ID! The ID for the resource that is to be added to the queue of the current user. For example, this could be a course ID that the user would like to view at a later time.
resourceType - ContentKind The type of content that is to be added to the queue of the current user.

Example

Query
mutation AddResourceToQueue(
  $resourceId: ID!,
  $resourceType: ContentKind
) {
  AddResourceToQueue(
    resourceId: $resourceId,
    resourceType: $resourceType
  )
}
Variables
{
  "resourceId": "4",
  "resourceType": "article"
}
Response
{"data": {"AddResourceToQueue": true}}

ArchiveUserCourse

Description

Archives a user's access to a course. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
id - ID! The ID of the course to be archived.

Example

Query
mutation ArchiveUserCourse($id: ID!) {
  ArchiveUserCourse(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"ArchiveUserCourse": "4"}}

ArchiveUserLearningPath

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation ArchiveUserLearningPath($id: ID!) {
  ArchiveUserLearningPath(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"ArchiveUserLearningPath": 4}}

CreateAssessmentAttempt

Description

Creates an assessment attempt for a course assessment. This is used to create a super quiz attempt with user's selected questions. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
courseId - ID! The ID of the Course.
questions - [QuestionInput!]! The questions user selected for super quiz.
topicId - ID! The ID of the Topic.

Example

Query
mutation CreateAssessmentAttempt(
  $courseId: ID!,
  $questions: [QuestionInput!]!,
  $topicId: ID!
) {
  CreateAssessmentAttempt(
    courseId: $courseId,
    questions: $questions,
    topicId: $topicId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "courseId": "4",
  "questions": [QuestionInput],
  "topicId": 4
}
Response
{
  "data": {
    "CreateAssessmentAttempt": {
      "adminUpdatedGrade": false,
      "answeredQuestionsCount": 123,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": 4,
      "correctQuestionsCount": 123,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 123,
      "id": 4,
      "linkedWorkbook": 4,
      "originalGrade": 987,
      "passed": false,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 987,
      "status": "finished",
      "timeElapsedInSeconds": 987,
      "topic": Topic,
      "topicId": 4,
      "topicType": "ad",
      "unansweredQuestionsCount": 987,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

CreateAssignmentSubmission

Description

Creates an assignment submission. This is used when user works on a manually graded assessment, the assessment attempt will be associated with the assignment submission. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an AssignmentSubmission!

Arguments
Name Description
asset - String The URL of the asset.
assignment - ID The ID of the assignment.
body - String The body of the assignment submission.
course - ID! The ID of the course.
quizAttempt - ID The ID of the assessment attempt.
videoAsset - String The URL of the video asset.

Example

Query
mutation CreateAssignmentSubmission(
  $asset: String,
  $assignment: ID,
  $body: String,
  $course: ID!,
  $quizAttempt: ID,
  $videoAsset: String
) {
  CreateAssignmentSubmission(
    asset: $asset,
    assignment: $assignment,
    body: $body,
    course: $course,
    quizAttempt: $quizAttempt,
    videoAsset: $videoAsset
  ) {
    adminUpdatedGrade
    asset
    assignment {
      id
      title
    }
    body
    commentsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    grade
    gradeFeedback
    id
    numericGrade
    quizAttempt {
      adminUpdatedGrade
      answeredQuestionsCount
      answers {
        ...AssessmentAnswerFragment
      }
      assessment {
        ...AssessmentFragment
      }
      assignmentSubmissionId
      correctQuestionsCount
      course {
        ...CourseFragment
      }
      courseId
      createdAt
      forgiven
      grade
      id
      linkedWorkbook
      originalGrade
      passed
      poolLabelByQuestionId
      questions {
        ...QuizQuestionFragment
      }
      questionsWithChoicesCount
      status
      timeElapsedInSeconds
      topic {
        ...TopicFragment
      }
      topicId
      topicType
      unansweredQuestionsCount
      updatedAt
      user {
        ...UserFragment
      }
    }
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
    videoAsset
  }
}
Variables
{
  "asset": "abc123",
  "assignment": "4",
  "body": "xyz789",
  "course": 4,
  "quizAttempt": "4",
  "videoAsset": "xyz789"
}
Response
{
  "data": {
    "CreateAssignmentSubmission": {
      "adminUpdatedGrade": true,
      "asset": "http://www.test.com/",
      "assignment": Assignment,
      "body": "xyz789",
      "commentsCount": 987,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "grade": "completed",
      "gradeFeedback": "abc123",
      "id": 4,
      "numericGrade": 987.65,
      "quizAttempt": AssessmentAttempt,
      "updatedAt": "2007-12-03",
      "user": User,
      "videoAsset": "xyz789"
    }
  }
}

CreateCertificateFromUpload

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Certificate!

Arguments
Name Description
asset - URL!
certificateUploadFields - [CertificateUploadField!]

Example

Query
mutation CreateCertificateFromUpload(
  $asset: URL!,
  $certificateUploadFields: [CertificateUploadField!]
) {
  CreateCertificateFromUpload(
    asset: $asset,
    certificateUploadFields: $certificateUploadFields
  ) {
    certificateTemplate {
      asset
      assetLibraryId
      customCss
      expirationDate
      expirationDays
      id
      isExpired
      labels {
        ...CertificateTemplateLabelFragment
      }
      recertificationAction
      recertificationActionText
      recertificationActionUrl
      recertificationAfterDays
      recertificationAutoReset
      recertificationInstructions
      resource
      resourceType
      supplementalAssets
      title
      userCustomField {
        ...UserCustomFieldFragment
      }
      userCustomFieldSlug
      userCustomFieldValue
    }
    contentItem {
      acceptBadgeUrl
      altDescriptionBody
      alternativePricingRef
      alternativePricingType
      asset
      authors
      authorsAndInstructors
      availabilityStatus
      badgeName
      badgeUrl
      bulkPurchasingEnabled
      canAddToQueue
      contentTypeAssetAspectRatio
      contentTypeLabel
      courseEndDate
      courseGracePeriodEnded
      courseGroup
      coursePresold
      courseStartDate
      createdAt
      credlyBadgeExpiresAt
      currentUserMayReschedule
      currentUserUnmetCoursePrerequisites
      currentUserUnmetLearningPathPrerequisites
      customFields
      description
      displayCourse
      displayCourseSlug
      displayDate
      embeddedEnabled
      enrollmentCount
      enrollmentEndDate
      enrollmentStartDate
      expiresAt
      hasChildren
      hideCourseDescription
      id
      imageUrl
      isActive
      issuedAt
      kind
      language
      location {
        ...LocationFragment
      }
      meetingStartDate
      metaDescription
      metaTitle
      priceInCents
      publishDate
      rating
      ribbon {
        ...RibbonFragment
      }
      seatsLimit
      sessionTitle
      sku
      slug
      source
      state
      status
      suggestedRetailPriceInCents
      tags {
        ...TagFragment
      }
      timeZone
      title
      updatedAt
      url
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
    }
    deleted
    didExpire
    expirationDate
    externalResourceTitle
    id
    identifier
    isExpired
    isExternal
    issuedAt
    pdfAsset
    progressWasReset
    recertificationDate
    resource
    resourceId
    resourceType
    resourceTypeLabel
    source
    url
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "asset": "http://www.test.com/",
  "certificateUploadFields": [CertificateUploadField]
}
Response
{
  "data": {
    "CreateCertificateFromUpload": {
      "certificateTemplate": CertificateTemplate,
      "contentItem": Content,
      "deleted": false,
      "didExpire": true,
      "expirationDate": "2007-12-03",
      "externalResourceTitle": "xyz789",
      "id": 4,
      "identifier": "abc123",
      "isExpired": true,
      "isExternal": true,
      "issuedAt": "2007-12-03",
      "pdfAsset": AbsoluteOrRelativeURL,
      "progressWasReset": true,
      "recertificationDate": "2007-12-03",
      "resource": Course,
      "resourceId": 4,
      "resourceType": "course",
      "resourceTypeLabel": "abc123",
      "source": "abc123",
      "url": AbsoluteOrRelativeURL,
      "user": User
    }
  }
}

CreateComment

Description

Creates a comment. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Comment!

Arguments
Name Description
asset - URL The URL of the asset.
assetFileName - String The file name of the asset.
body - String The body of the comment.
clientId - ID The ID of the Client.
commentableId - ID! The ID of the commentable entity.
commentableType - CommentableType! The type of the comment's parent thread, based on the comment's location, e.g. discussion board, assignment, widget thread etc.
notificationsEnabled - Boolean! Flag to enable notifications.
parentId - ID The ID of the parent comment.
videoAsset - ID The ID of the video asset.

Example

Query
mutation CreateComment(
  $asset: URL,
  $assetFileName: String,
  $body: String,
  $clientId: ID,
  $commentableId: ID!,
  $commentableType: CommentableType!,
  $notificationsEnabled: Boolean!,
  $parentId: ID,
  $videoAsset: ID
) {
  CreateComment(
    asset: $asset,
    assetFileName: $assetFileName,
    body: $body,
    clientId: $clientId,
    commentableId: $commentableId,
    commentableType: $commentableType,
    notificationsEnabled: $notificationsEnabled,
    parentId: $parentId,
    videoAsset: $videoAsset
  ) {
    asset
    assetFileName
    body
    childComments {
      comments {
        ...CommentFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
    }
    commentable
    commentableId
    commentableType
    createdAt
    id
    likesCount
    notificationsEnabled
    parentComment {
      asset
      assetFileName
      body
      childComments {
        ...CommentsListFragment
      }
      commentable
      commentableId
      commentableType
      createdAt
      id
      likesCount
      notificationsEnabled
      parentComment {
        ...CommentFragment
      }
      updatedAt
      user {
        ...UserFragment
      }
      userLikeId
      videoAsset
    }
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
    userLikeId
    videoAsset
  }
}
Variables
{
  "asset": "http://www.test.com/",
  "assetFileName": "xyz789",
  "body": "abc123",
  "clientId": 4,
  "commentableId": "4",
  "commentableType": "assignment",
  "notificationsEnabled": true,
  "parentId": 4,
  "videoAsset": 4
}
Response
{
  "data": {
    "CreateComment": {
      "asset": "http://www.test.com/",
      "assetFileName": "abc123",
      "body": "xyz789",
      "childComments": CommentsList,
      "commentable": Thread,
      "commentableId": 4,
      "commentableType": "assignment",
      "createdAt": "2007-12-03",
      "id": "4",
      "likesCount": 123,
      "notificationsEnabled": false,
      "parentComment": Comment,
      "updatedAt": "2007-12-03",
      "user": User,
      "userLikeId": "4",
      "videoAsset": 4
    }
  }
}

CreateCommentLike

Description

Adds a like to a comment. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID!

Arguments
Name Description
clientId - ID The ID of the Client.
commentId - ID! The ID of the Comment.
commentableId - ID! The ID of the commentable entity.
commentableType - String! The type of thread, based on the thread's location, e.g. discussion board, assignment, widget thread etc.

Example

Query
mutation CreateCommentLike(
  $clientId: ID,
  $commentId: ID!,
  $commentableId: ID!,
  $commentableType: String!
) {
  CreateCommentLike(
    clientId: $clientId,
    commentId: $commentId,
    commentableId: $commentableId,
    commentableType: $commentableType
  )
}
Variables
{
  "clientId": "4",
  "commentId": 4,
  "commentableId": "4",
  "commentableType": "abc123"
}
Response
{"data": {"CreateCommentLike": 4}}

CreateInPersonEvent

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Course!

Arguments
Name Description
contentType - String
endDate - Date!
language - String
meetings - [MeetingFields!]!
startDate - Date!
title - String!

Example

Query
mutation CreateInPersonEvent(
  $contentType: String,
  $endDate: Date!,
  $language: String,
  $meetings: [MeetingFields!]!,
  $startDate: Date!,
  $title: String!
) {
  CreateInPersonEvent(
    contentType: $contentType,
    endDate: $endDate,
    language: $language,
    meetings: $meetings,
    startDate: $startDate,
    title: $title
  ) {
    accessDays
    alternativePricingRef
    alternativePricingType
    appearanceBlock
    appearanceHash
    askLearnerPassword
    availabilityStatus
    awardClaimingOptions {
      awardAmounts
      awardType {
        ...AwardTypeFragment
      }
      awardTypeId
      range
    }
    balanceRequirement
    bulkPurchasingEnabled
    completionTimePerPage
    confirmationBlock
    courseEndDate
    courseGroup {
      allowRescheduling
      archived
      asset
      authors
      availabilityStatus
      contentType {
        ...ContentTypeFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentUserMayReschedule
      customFields
      description
      detailAsset
      displayBundle {
        ...DisplayBundleFragment
      }
      displayCourse {
        ...CourseFragment
      }
      externalDetailUrl
      externalPurchaseUrl
      hasParentCourseGroup
      id
      isbn
      kind
      language
      layout {
        ...LayoutFragment
      }
      metaDescription
      metaTitle
      ownedByActiveScope
      rating
      relatedCourseGroups {
        ...CourseGroupFragment
      }
      relatedQuery
      relatedQueryLimit
      relatedQuerySignature
      relatedQuerySort
      relatedShowDescription
      relatedShowImageAsset
      ribbon
      slug
      source
      tabs {
        ...CourseTabFragment
      }
      tags {
        ...TagFragment
      }
      title
      videoAsset
    }
    courseStartDate
    createdAt
    currentUserHasAccess
    customFields
    discussionsEnabled
    displayMap
    displayResults
    embeddedEnabled
    enrollmentActive
    enrollmentEndDate
    enrollmentStartDate
    finalAssessment
    forceLinearProgress
    freeWithRegistration
    fulfillmentCenter
    futurePublishDate
    galleryEnabled
    gracePeriodEndDate
    hasChildren
    hasMultipleCurrencies
    id
    inPersonEventInfo {
      heroAsset
      subtitle
    }
    instructorAccessEnabled
    instructorAccessPriceInCents
    instructorEmails
    isActive
    isChild
    kind
    lastTierPriceInCents
    linkedWorkbookEnabled
    linkedWorkbookSkipEnabled
    location {
      address1
      address2
      city
      country
      id
      name
      room
      state
      timeZone
      zipCode
    }
    meetings {
      attendeeInfo
      attendees {
        ...UserFragment
      }
      course {
        ...CourseFragment
      }
      courseId
      endDate
      id
      instructors
      location {
        ...LocationFragment
      }
      locationId
      startDate
      timeZone
      title
    }
    meetingsOverviewEnabled
    parentCourseId
    paywallsBlock
    prerequisiteCourses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    prerequisiteLearningPaths {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    priceInCents
    prices {
      annualPriceInCents
      currencyCode
      id
      instructorAccessPriceInCents
      priceInCents
      suggestedRetailPriceInCents
      variations {
        ...ItemPriceVariationFragment
      }
    }
    publishDate
    purchasable
    resourcesEnabled
    roster
    rosterSubmittedDate
    sampleLesson {
      accessLevel
      id
      section {
        ...SectionFragment
      }
      slug
      slugOrId
      title
      topics
    }
    sampleLessonId
    scormCollectUserDetails
    seatPackages {
      seats
    }
    seatTiers {
      priceInCents
      seats
    }
    seatsAllocatedCount
    seatsLimit
    seatsLimitMet
    seatsUsedCount
    sections {
      id
      lessons {
        ...LessonFragment
      }
      slug
      status
      title
    }
    sessionIsTitled
    showProgress
    showSyllabusWhileUnenrolled
    sku
    slug
    status
    suggestedRetailPriceInCents
    superquizEnabled
    syllabusTitlesEnabled
    taxCategory
    taxable
    termsBlock
    title
    topicGroup
    updatedAt
    waitlistActive
    waitlistCount
    waitlistingEnabled
    waitlistingTriggered
    webinarDates {
      endDate
      startDate
    }
    webinarDetails {
      attendeeDialIn
      coOrganizers
      enableAutoRecording
      id
      joinUrl
      organizerDialIn
      originalWebinarDates {
        ...WebinarDateFragment
      }
      recurrence
      retrieveRecording
      timeZone
      webexDescription
      webexLabName
      webexNumComputers
      webexReserveHOL
      webexSessionPassword
      webinarDates {
        ...WebinarDateFragment
      }
      webinarProvider
      webinarType
    }
    webinarId
    webinarTimeZone
    workbookEnabled
  }
}
Variables
{
  "contentType": "xyz789",
  "endDate": "2007-12-03",
  "language": "xyz789",
  "meetings": [MeetingFields],
  "startDate": "2007-12-03",
  "title": "xyz789"
}
Response
{
  "data": {
    "CreateInPersonEvent": {
      "accessDays": 123,
      "alternativePricingRef": 123,
      "alternativePricingType": "membership",
      "appearanceBlock": "4",
      "appearanceHash": "abc123",
      "askLearnerPassword": false,
      "availabilityStatus": "xyz789",
      "awardClaimingOptions": [CourseAwardClaimingOption],
      "balanceRequirement": 987.65,
      "bulkPurchasingEnabled": true,
      "completionTimePerPage": 987,
      "confirmationBlock": "4",
      "courseEndDate": "2007-12-03",
      "courseGroup": "courseGroup-1",
      "courseStartDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "currentUserHasAccess": true,
      "customFields": {},
      "discussionsEnabled": false,
      "displayMap": true,
      "displayResults": false,
      "embeddedEnabled": false,
      "enrollmentActive": true,
      "enrollmentEndDate": "2007-12-03",
      "enrollmentStartDate": "2007-12-03",
      "finalAssessment": "abc123",
      "forceLinearProgress": true,
      "freeWithRegistration": true,
      "fulfillmentCenter": 4,
      "futurePublishDate": "2007-12-03",
      "galleryEnabled": true,
      "gracePeriodEndDate": "2007-12-03",
      "hasChildren": false,
      "hasMultipleCurrencies": false,
      "id": "4",
      "inPersonEventInfo": InPersonEventInfo,
      "instructorAccessEnabled": true,
      "instructorAccessPriceInCents": 987,
      "instructorEmails": ["abc123"],
      "isActive": true,
      "isChild": false,
      "kind": "article",
      "lastTierPriceInCents": 123,
      "linkedWorkbookEnabled": true,
      "linkedWorkbookSkipEnabled": false,
      "location": Location,
      "meetings": [Meeting],
      "meetingsOverviewEnabled": true,
      "parentCourseId": 4,
      "paywallsBlock": "4",
      "prerequisiteCourses": [Course],
      "prerequisiteLearningPaths": [LearningPath],
      "priceInCents": 123,
      "prices": [ItemPrice],
      "publishDate": "2007-12-03",
      "purchasable": true,
      "resourcesEnabled": true,
      "roster": false,
      "rosterSubmittedDate": "2007-12-03",
      "sampleLesson": Lesson,
      "sampleLessonId": 4,
      "scormCollectUserDetails": false,
      "seatPackages": [SeatPackage],
      "seatTiers": [SeatTier],
      "seatsAllocatedCount": 123,
      "seatsLimit": 123,
      "seatsLimitMet": false,
      "seatsUsedCount": 123,
      "sections": [Section],
      "sessionIsTitled": false,
      "showProgress": true,
      "showSyllabusWhileUnenrolled": false,
      "sku": "abc123",
      "slug": Slug,
      "status": "archived",
      "suggestedRetailPriceInCents": 123,
      "superquizEnabled": true,
      "syllabusTitlesEnabled": true,
      "taxCategory": "4",
      "taxable": true,
      "termsBlock": 4,
      "title": "xyz789",
      "topicGroup": "4",
      "updatedAt": "2007-12-03",
      "waitlistActive": false,
      "waitlistCount": 123,
      "waitlistingEnabled": true,
      "waitlistingTriggered": true,
      "webinarDates": [DateRange],
      "webinarDetails": WebinarBlock,
      "webinarId": "xyz789",
      "webinarTimeZone": "abc123",
      "workbookEnabled": false
    }
  }
}

CreateLearner

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a User!

Arguments
Name Description
clientId - ID The ID of the Client.
email - String!
firstName - String!
lastName - String!
licenseIds - [ID!]

Example

Query
mutation CreateLearner(
  $clientId: ID,
  $email: String!,
  $firstName: String!,
  $lastName: String!,
  $licenseIds: [ID!]
) {
  CreateLearner(
    clientId: $clientId,
    email: $email,
    firstName: $firstName,
    lastName: $lastName,
    licenseIds: $licenseIds
  ) {
    abbreviatedName
    accessedFlows
    activeLicense {
      accessDays
      appearance {
        ...AppearanceSettingsFragment
      }
      childLicenses {
        ...LicenseFragment
      }
      client {
        ...ClientFragment
      }
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      dashboardLayoutId
      enableBranding
      expirationDate
      id
      isDefault
      label
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      name
      parentLicense {
        ...LicenseFragment
      }
      parentLicenseId
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      schoolName
      seatsLimit
      sku
      updatedAt
    }
    address1
    address2
    adminClients {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    allocatedLearningPaths {
      learningPath {
        ...LearningPathFragment
      }
      learningPathId
    }
    allocatedLicenses {
      license {
        ...LicenseFragment
      }
      licenseId
      licenseRole
      status
    }
    asset
    attendedMeetings {
      attendanceDate
      meeting {
        ...MeetingFragment
      }
      user {
        ...UserFragment
      }
    }
    availableCoursesCount
    balance
    bio
    certificatesCount
    city
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    clientId
    collaborationsCount
    completedCoursesCount
    country
    createdAt
    customFields
    disabled
    email
    externalCustomerId
    firstName
    id
    invitedByName
    lang
    lastActiveAt
    lastInitial
    lastName
    learnerUserId
    managerUserId
    mustVerifyEmail
    name
    purchasedBundles {
      bundle {
        ...BundleFragment
      }
      bundleId
    }
    purchasedCourses {
      certificate
      certificateIssuedAt
      course {
        ...CourseFragment
      }
      courseId
      instructorAccessPurchased
      status
    }
    recommendedSlugs {
      boost
      slug
    }
    recommendedTags {
      boost
      label
    }
    ref1
    ref2
    ref3
    ref4
    ref5
    ref6
    ref7
    ref8
    ref9
    ref10
    roleKey
    sfAccountId
    sfContactId
    shippingName
    shouldHighlight
    startedCoursesCount
    state
    stripeCustomerId
    telephone
    twoFactorEnabled
    updatedAt
    waitlistedCourses {
      course {
        ...CourseFragment
      }
      courseId
    }
    zipCode
  }
}
Variables
{
  "clientId": "4",
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "licenseIds": [4]
}
Response
{
  "data": {
    "CreateLearner": {
      "abbreviatedName": "abc123",
      "accessedFlows": ["abc123"],
      "activeLicense": License,
      "address1": "xyz789",
      "address2": "abc123",
      "adminClients": [Client],
      "allocatedLearningPaths": [AllocatedLearningPath],
      "allocatedLicenses": [AllocatedLicense],
      "asset": "xyz789",
      "attendedMeetings": [UserAttendedMeeting],
      "availableCoursesCount": 987,
      "balance": 123.45,
      "bio": "abc123",
      "certificatesCount": 123,
      "city": "abc123",
      "client": "client-1",
      "clientId": "client-1",
      "collaborationsCount": 123,
      "completedCoursesCount": 123,
      "country": "xyz789",
      "createdAt": "2007-12-03",
      "customFields": {},
      "disabled": true,
      "email": "xyz789",
      "externalCustomerId": 4,
      "firstName": "xyz789",
      "id": 4,
      "invitedByName": "abc123",
      "lang": "xyz789",
      "lastActiveAt": "2007-12-03",
      "lastInitial": "xyz789",
      "lastName": "xyz789",
      "learnerUserId": "4",
      "managerUserId": 4,
      "mustVerifyEmail": true,
      "name": "xyz789",
      "purchasedBundles": [PurchasedBundle],
      "purchasedCourses": [PurchasedCourse],
      "recommendedSlugs": [UserRecommendedSlug],
      "recommendedTags": [UserRecommendedTag],
      "ref1": "xyz789",
      "ref2": "xyz789",
      "ref3": "abc123",
      "ref4": "abc123",
      "ref5": "abc123",
      "ref6": "abc123",
      "ref7": "abc123",
      "ref8": "abc123",
      "ref9": "xyz789",
      "ref10": "abc123",
      "roleKey": "xyz789",
      "sfAccountId": 4,
      "sfContactId": "4",
      "shippingName": "abc123",
      "shouldHighlight": false,
      "startedCoursesCount": 123,
      "state": "abc123",
      "stripeCustomerId": "4",
      "telephone": "xyz789",
      "twoFactorEnabled": false,
      "updatedAt": "2007-12-03",
      "waitlistedCourses": [WaitlistedCourse],
      "zipCode": "xyz789"
    }
  }
}

CreateLearners

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns [User]!

Arguments
Name Description
learners - [LearnerInput!]!

Example

Query
mutation CreateLearners($learners: [LearnerInput!]!) {
  CreateLearners(learners: $learners) {
    abbreviatedName
    accessedFlows
    activeLicense {
      accessDays
      appearance {
        ...AppearanceSettingsFragment
      }
      childLicenses {
        ...LicenseFragment
      }
      client {
        ...ClientFragment
      }
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      dashboardLayoutId
      enableBranding
      expirationDate
      id
      isDefault
      label
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      name
      parentLicense {
        ...LicenseFragment
      }
      parentLicenseId
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      schoolName
      seatsLimit
      sku
      updatedAt
    }
    address1
    address2
    adminClients {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    allocatedLearningPaths {
      learningPath {
        ...LearningPathFragment
      }
      learningPathId
    }
    allocatedLicenses {
      license {
        ...LicenseFragment
      }
      licenseId
      licenseRole
      status
    }
    asset
    attendedMeetings {
      attendanceDate
      meeting {
        ...MeetingFragment
      }
      user {
        ...UserFragment
      }
    }
    availableCoursesCount
    balance
    bio
    certificatesCount
    city
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    clientId
    collaborationsCount
    completedCoursesCount
    country
    createdAt
    customFields
    disabled
    email
    externalCustomerId
    firstName
    id
    invitedByName
    lang
    lastActiveAt
    lastInitial
    lastName
    learnerUserId
    managerUserId
    mustVerifyEmail
    name
    purchasedBundles {
      bundle {
        ...BundleFragment
      }
      bundleId
    }
    purchasedCourses {
      certificate
      certificateIssuedAt
      course {
        ...CourseFragment
      }
      courseId
      instructorAccessPurchased
      status
    }
    recommendedSlugs {
      boost
      slug
    }
    recommendedTags {
      boost
      label
    }
    ref1
    ref2
    ref3
    ref4
    ref5
    ref6
    ref7
    ref8
    ref9
    ref10
    roleKey
    sfAccountId
    sfContactId
    shippingName
    shouldHighlight
    startedCoursesCount
    state
    stripeCustomerId
    telephone
    twoFactorEnabled
    updatedAt
    waitlistedCourses {
      course {
        ...CourseFragment
      }
      courseId
    }
    zipCode
  }
}
Variables
{"learners": [LearnerInput]}
Response
{
  "data": {
    "CreateLearners": [
      {
        "abbreviatedName": "xyz789",
        "accessedFlows": ["xyz789"],
        "activeLicense": License,
        "address1": "abc123",
        "address2": "xyz789",
        "adminClients": [Client],
        "allocatedLearningPaths": [AllocatedLearningPath],
        "allocatedLicenses": [AllocatedLicense],
        "asset": "xyz789",
        "attendedMeetings": [UserAttendedMeeting],
        "availableCoursesCount": 987,
        "balance": 987.65,
        "bio": "abc123",
        "certificatesCount": 123,
        "city": "abc123",
        "client": "client-1",
        "clientId": "client-1",
        "collaborationsCount": 987,
        "completedCoursesCount": 987,
        "country": "xyz789",
        "createdAt": "2007-12-03",
        "customFields": {},
        "disabled": false,
        "email": "xyz789",
        "externalCustomerId": "4",
        "firstName": "abc123",
        "id": "4",
        "invitedByName": "abc123",
        "lang": "abc123",
        "lastActiveAt": "2007-12-03",
        "lastInitial": "xyz789",
        "lastName": "xyz789",
        "learnerUserId": "4",
        "managerUserId": 4,
        "mustVerifyEmail": false,
        "name": "abc123",
        "purchasedBundles": [PurchasedBundle],
        "purchasedCourses": [PurchasedCourse],
        "recommendedSlugs": [UserRecommendedSlug],
        "recommendedTags": [UserRecommendedTag],
        "ref1": "abc123",
        "ref2": "abc123",
        "ref3": "xyz789",
        "ref4": "abc123",
        "ref5": "xyz789",
        "ref6": "abc123",
        "ref7": "abc123",
        "ref8": "abc123",
        "ref9": "abc123",
        "ref10": "xyz789",
        "roleKey": "abc123",
        "sfAccountId": 4,
        "sfContactId": "4",
        "shippingName": "abc123",
        "shouldHighlight": false,
        "startedCoursesCount": 123,
        "state": "abc123",
        "stripeCustomerId": 4,
        "telephone": "xyz789",
        "twoFactorEnabled": false,
        "updatedAt": "2007-12-03",
        "waitlistedCourses": [WaitlistedCourse],
        "zipCode": "xyz789"
      }
    ]
  }
}

CreateLearningPath

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a LearningPath!

Arguments
Name Description
clientId - ID The ID of the Client.
language - String
milestones - [MilestoneInput!]!
name - String!

Example

Query
mutation CreateLearningPath(
  $clientId: ID,
  $language: String,
  $milestones: [MilestoneInput!]!,
  $name: String!
) {
  CreateLearningPath(
    clientId: $clientId,
    language: $language,
    milestones: $milestones,
    name: $name
  ) {
    accessDays
    alternativePricingRef
    alternativePricingType
    asset
    authors
    availabilityStatus
    bulkPurchasingEnabled
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    confirmationHtml
    contentType
    createdAt
    currentUserEarnedCertificate
    currentUserPendingCertificate
    currentUserStartActionDate
    customFields
    detailAsset
    endDate
    enrollmentEndDate
    enrollmentStartDate
    externalDetailUrl
    freeWithRegistration
    fulfillmentCenter
    futurePublishDate
    hasMultipleCurrencies
    heroAsset
    id
    isPayAsYouGo
    kind
    language
    lastTierPriceInCents
    layout {
      hasEnrollmentWidget
      id
      kind
      scripts
      widgets
    }
    layoutId
    learnerLayout {
      hasEnrollmentWidget
      id
      kind
      scripts
      widgets
    }
    learnerLayoutId
    longDescription
    metaDescription
    metaTitle
    milestones {
      completionCriteria {
        ...MilestoneCompletionCriteriaFragment
      }
      completionCriteriaDescription
      contentItems {
        ...ContentFragment
      }
      id
      kind
      learningPath {
        ...LearningPathFragment
      }
      milestoneCompetencyAssessment {
        ...MilestoneCompetencyAssessmentFragment
      }
      milestoneCourses {
        ...MilestoneCourseFragment
      }
      name
      releaseDate
      releaseDays
      requirement
    }
    name
    prerequisiteCourses {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    prerequisiteLearningPaths {
      accessDays
      alternativePricingRef
      alternativePricingType
      asset
      authors
      availabilityStatus
      bulkPurchasingEnabled
      client {
        ...ClientFragment
      }
      confirmationHtml
      contentType
      createdAt
      currentUserEarnedCertificate
      currentUserPendingCertificate
      currentUserStartActionDate
      customFields
      detailAsset
      endDate
      enrollmentEndDate
      enrollmentStartDate
      externalDetailUrl
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      hasMultipleCurrencies
      heroAsset
      id
      isPayAsYouGo
      kind
      language
      lastTierPriceInCents
      layout {
        ...LayoutFragment
      }
      layoutId
      learnerLayout {
        ...LayoutFragment
      }
      learnerLayoutId
      longDescription
      metaDescription
      metaTitle
      milestones {
        ...MilestoneFragment
      }
      name
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      relatedQuery
      relatedQuerySignature
      resourceType
      ribbon {
        ...RibbonFragment
      }
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsLimit
      shortDescription
      sku
      slug
      source
      startDate
      status
      suggestedRetailPriceInCents
      tabs {
        ...LearningPathTabsFragment
      }
      tags {
        ...TagFragment
      }
      taxCategory
      taxable
      updatedAt
      videoAsset
    }
    priceInCents
    prices {
      annualPriceInCents
      currencyCode
      id
      instructorAccessPriceInCents
      priceInCents
      suggestedRetailPriceInCents
      variations {
        ...ItemPriceVariationFragment
      }
    }
    publishDate
    purchasable
    relatedQuery
    relatedQuerySignature
    resourceType
    ribbon {
      color
      contrastColor
      darkerColor
      label
      slug
    }
    seatPackages {
      seats
    }
    seatTiers {
      priceInCents
      seats
    }
    seatsLimit
    shortDescription
    sku
    slug
    source
    startDate
    status
    suggestedRetailPriceInCents
    tabs {
      generated
      id
      tabs {
        ...LearningPathTabFragment
      }
    }
    tags {
      id
      isFolder
      label
      updatedAt
    }
    taxCategory
    taxable
    updatedAt
    videoAsset
  }
}
Variables
{
  "clientId": "4",
  "language": "abc123",
  "milestones": [MilestoneInput],
  "name": "abc123"
}
Response
{
  "data": {
    "CreateLearningPath": {
      "accessDays": 987,
      "alternativePricingRef": 987,
      "alternativePricingType": "membership",
      "asset": "http://www.test.com/",
      "authors": ["xyz789"],
      "availabilityStatus": "xyz789",
      "bulkPurchasingEnabled": true,
      "client": "client-1",
      "confirmationHtml": "abc123",
      "contentType": "xyz789",
      "createdAt": "2007-12-03",
      "currentUserEarnedCertificate": true,
      "currentUserPendingCertificate": true,
      "currentUserStartActionDate": "2007-12-03",
      "customFields": {},
      "detailAsset": "http://www.test.com/",
      "endDate": "2007-12-03",
      "enrollmentEndDate": "2007-12-03",
      "enrollmentStartDate": "2007-12-03",
      "externalDetailUrl": "xyz789",
      "freeWithRegistration": false,
      "fulfillmentCenter": "4",
      "futurePublishDate": "2007-12-03",
      "hasMultipleCurrencies": true,
      "heroAsset": "http://www.test.com/",
      "id": 4,
      "isPayAsYouGo": false,
      "kind": "xyz789",
      "language": "abc123",
      "lastTierPriceInCents": 987,
      "layout": Layout,
      "layoutId": 4,
      "learnerLayout": Layout,
      "learnerLayoutId": "4",
      "longDescription": "abc123",
      "metaDescription": "xyz789",
      "metaTitle": "abc123",
      "milestones": [Milestone],
      "name": "abc123",
      "prerequisiteCourses": [Course],
      "prerequisiteLearningPaths": [LearningPath],
      "priceInCents": 987,
      "prices": [ItemPrice],
      "publishDate": "2007-12-03",
      "purchasable": false,
      "relatedQuery": "abc123",
      "relatedQuerySignature": "xyz789",
      "resourceType": "abc123",
      "ribbon": Ribbon,
      "seatPackages": [SeatPackage],
      "seatTiers": [SeatTier],
      "seatsLimit": 987,
      "shortDescription": "abc123",
      "sku": "xyz789",
      "slug": Slug,
      "source": "abc123",
      "startDate": "2007-12-03",
      "status": "archived",
      "suggestedRetailPriceInCents": 987,
      "tabs": LearningPathTabs,
      "tags": [Tag],
      "taxCategory": "4",
      "taxable": true,
      "updatedAt": "2007-12-03",
      "videoAsset": "4"
    }
  }
}

CreateThread

Description

Creates a thread of comments under a commentable type. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Thread

Arguments
Name Description
asset - URL The URL of the asset.
assetFileName - String The file name of the asset.
body - String The body of the comment.
clientId - ID The ID of the Client.
commentableType - CommentableType The type of thread to create, based on the thread's location, e.g. discussion board, assignment, widget thread etc.
courseId - ID The ID of the Course.
forumId - ID! The ID of the Forum.
layoutId - ID The ID of the Layout.
notificationsEnabled - Boolean! Flag to enable notifications.
title - String! The title of the comment.
videoAsset - ID The ID of the video asset.
widgetTitle - String The title of the widget.

Example

Query
mutation CreateThread(
  $asset: URL,
  $assetFileName: String,
  $body: String,
  $clientId: ID,
  $commentableType: CommentableType,
  $courseId: ID,
  $forumId: ID!,
  $layoutId: ID,
  $notificationsEnabled: Boolean!,
  $title: String!,
  $videoAsset: ID,
  $widgetTitle: String
) {
  CreateThread(
    asset: $asset,
    assetFileName: $assetFileName,
    body: $body,
    clientId: $clientId,
    commentableType: $commentableType,
    courseId: $courseId,
    forumId: $forumId,
    layoutId: $layoutId,
    notificationsEnabled: $notificationsEnabled,
    title: $title,
    videoAsset: $videoAsset,
    widgetTitle: $widgetTitle
  ) {
    asset
    assetFileName
    body
    bookmark
    client {
      allocatedCredits
      appearance {
        ...AppearanceSettingsFragment
      }
      autoFilterForSelectedLanguage
      catalog {
        ...CatalogSettingsFragment
      }
      clientSubscriptionNeedsSetup
      courseIds
      courseTagIds
      courseTags {
        ...TagFragment
      }
      courses {
        ...CourseFragment
      }
      createdAt
      currentBalance
      currentUserManagerAllocatedLicenseTree {
        ...LicenseNodeFragment
      }
      customHost
      dashboardLayoutId
      defaultLanguage
      disabled
      emailLayout {
        ...EmailLayoutSettingsFragment
      }
      enableBranding
      enableCommunitiesSegmentation
      enableContentDetailPage
      enableCreditPurchasing
      enableCustomEmailSettings
      enableDiscussions
      enableEcommerce
      enableGlobalLinks
      enableLicenseDashboards
      enableNavLinks
      enableOnboardingSurvey
      enableRecommendationAssessment
      enableSegmentation
      id
      languageSelectorEnabled
      languages
      learningPathIds
      learningPaths {
        ...LearningPathFragment
      }
      licenseEndDate
      licenseTree {
        ...LicenseNodeFragment
      }
      licenses {
        ...LicenseFragment
      }
      name
      notificationEmails
      panorama
      pendingJobs {
        ...BackgroundJobFragment
      }
      primaryLicense {
        ...LicenseFragment
      }
      purchasableContentIds
      purchasableTags {
        ...TagFragment
      }
      redemptionLayoutId
      schoolName
      seatsAllocatedCount
      seatsLimit
      seatsUsedCount
      secretKey
      sku
      slug
      sso {
        ...SSOSettingsFragment
      }
      startingBalance
      tags {
        ...TagFragment
      }
      updatedAt
    }
    commentsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    createdAt
    forum {
      course {
        ...CourseFragment
      }
      createdAt
      id
      isGeneral
      label
      sectionId
      threadsCount
      updatedAt
    }
    forumId
    id
    matchCount
    notificationsEnabled
    title
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
    videoAsset
  }
}
Variables
{
  "asset": "http://www.test.com/",
  "assetFileName": "xyz789",
  "body": "xyz789",
  "clientId": "4",
  "commentableType": "assignment",
  "courseId": 4,
  "forumId": "4",
  "layoutId": 4,
  "notificationsEnabled": false,
  "title": "xyz789",
  "videoAsset": "4",
  "widgetTitle": "xyz789"
}
Response
{
  "data": {
    "CreateThread": {
      "asset": "http://www.test.com/",
      "assetFileName": "xyz789",
      "body": "abc123",
      "bookmark": 4,
      "client": "client-1",
      "commentsCount": 123,
      "course": "course-1",
      "createdAt": "2007-12-03",
      "forum": Forum,
      "forumId": 4,
      "id": "4",
      "matchCount": 987,
      "notificationsEnabled": false,
      "title": "xyz789",
      "updatedAt": "2007-12-03",
      "user": User,
      "videoAsset": 4
    }
  }
}

CreateUnansweredAssessmentAttempt

Description

Creates an assessment attempt for unanswered questions. This is used when user skips questions during an assessment attempt and decides to review the unanswered questions. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
completedAssessmentAttemptId - ID! The ID of the last completed assessment attempt.
courseId - ID! The ID of the Course.
topicId - ID! The ID of the Topic.

Example

Query
mutation CreateUnansweredAssessmentAttempt(
  $completedAssessmentAttemptId: ID!,
  $courseId: ID!,
  $topicId: ID!
) {
  CreateUnansweredAssessmentAttempt(
    completedAssessmentAttemptId: $completedAssessmentAttemptId,
    courseId: $courseId,
    topicId: $topicId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "completedAssessmentAttemptId": 4,
  "courseId": "4",
  "topicId": "4"
}
Response
{
  "data": {
    "CreateUnansweredAssessmentAttempt": {
      "adminUpdatedGrade": true,
      "answeredQuestionsCount": 123,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": 4,
      "correctQuestionsCount": 987,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 123,
      "id": "4",
      "linkedWorkbook": 4,
      "originalGrade": 987,
      "passed": true,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 123,
      "status": "finished",
      "timeElapsedInSeconds": 123,
      "topic": Topic,
      "topicId": "4",
      "topicType": "ad",
      "unansweredQuestionsCount": 987,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

DestroyBookmark

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation DestroyBookmark($id: ID!) {
  DestroyBookmark(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"DestroyBookmark": "4"}}

DestroyBookmarkFolder

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID!

Arguments
Name Description
id - ID!

Example

Query
mutation DestroyBookmarkFolder($id: ID!) {
  DestroyBookmarkFolder(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"DestroyBookmarkFolder": 4}}

DestroyComment

Description

Removed a comment from a thread. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
commentableType - CommentableType The type of the comment's parent thread to destory, based on the thread's location, e.g. discussion board, assignment, widget thread etc.
id - ID! The ID of the comment.

Example

Query
mutation DestroyComment(
  $commentableType: CommentableType,
  $id: ID!
) {
  DestroyComment(
    commentableType: $commentableType,
    id: $id
  )
}
Variables
{"commentableType": "assignment", "id": 4}
Response
{"data": {"DestroyComment": "4"}}

DestroyThread

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
commentableType - CommentableType
id - ID!

Example

Query
mutation DestroyThread(
  $commentableType: CommentableType,
  $id: ID!
) {
  DestroyThread(
    commentableType: $commentableType,
    id: $id
  )
}
Variables
{"commentableType": "assignment", "id": "4"}
Response
{"data": {"DestroyThread": 4}}

Login

Description

Attempts to login the user. The mutation will perform a number of checks such as password validity and email verification status. If successful, the user will be logged in and an authentication token returned. If not, an appropriate error will be provided. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a String!

Arguments
Name Description
email - String! The email of the Current User attempting to log in.
password - String! The password of the Current User attempting to log in.

Example

Query
mutation Login(
  $email: String!,
  $password: String!
) {
  Login(
    email: $email,
    password: $password
  )
}
Variables
{
  "email": "abc123",
  "password": "abc123"
}
Response
{"data": {"Login": "xyz789"}}

Logout

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Boolean!

Example

Query
mutation Logout {
  Logout
}
Response
{"data": {"Logout": true}}

MergeAssessmentAttemptIntoComplete

Description

Merges an assessment attempt into the last completed assessment attempt. This is used after user finishes reviewing the unanswered questions, the current assessment attempt will be merged to the last completed assessment attempt. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an AssessmentAttempt!

Arguments
Name Description
assessmentAttemptId - ID! The ID of the Assessment Attempt.
completedAssessmentAttemptId - ID! The ID of the last completed assessment attempt.

Example

Query
mutation MergeAssessmentAttemptIntoComplete(
  $assessmentAttemptId: ID!,
  $completedAssessmentAttemptId: ID!
) {
  MergeAssessmentAttemptIntoComplete(
    assessmentAttemptId: $assessmentAttemptId,
    completedAssessmentAttemptId: $completedAssessmentAttemptId
  ) {
    adminUpdatedGrade
    answeredQuestionsCount
    answers {
      answer
      correct
      hasDefaultGrade
      id
      question
    }
    assessment {
      id
      minPassingPercent
      title
      type
    }
    assignmentSubmissionId
    correctQuestionsCount
    course {
      accessDays
      alternativePricingRef
      alternativePricingType
      appearanceBlock
      appearanceHash
      askLearnerPassword
      availabilityStatus
      awardClaimingOptions {
        ...CourseAwardClaimingOptionFragment
      }
      balanceRequirement
      bulkPurchasingEnabled
      completionTimePerPage
      confirmationBlock
      courseEndDate
      courseGroup {
        ...CourseGroupFragment
      }
      courseStartDate
      createdAt
      currentUserHasAccess
      customFields
      discussionsEnabled
      displayMap
      displayResults
      embeddedEnabled
      enrollmentActive
      enrollmentEndDate
      enrollmentStartDate
      finalAssessment
      forceLinearProgress
      freeWithRegistration
      fulfillmentCenter
      futurePublishDate
      galleryEnabled
      gracePeriodEndDate
      hasChildren
      hasMultipleCurrencies
      id
      inPersonEventInfo {
        ...InPersonEventInfoFragment
      }
      instructorAccessEnabled
      instructorAccessPriceInCents
      instructorEmails
      isActive
      isChild
      kind
      lastTierPriceInCents
      linkedWorkbookEnabled
      linkedWorkbookSkipEnabled
      location {
        ...LocationFragment
      }
      meetings {
        ...MeetingFragment
      }
      meetingsOverviewEnabled
      parentCourseId
      paywallsBlock
      prerequisiteCourses {
        ...CourseFragment
      }
      prerequisiteLearningPaths {
        ...LearningPathFragment
      }
      priceInCents
      prices {
        ...ItemPriceFragment
      }
      publishDate
      purchasable
      resourcesEnabled
      roster
      rosterSubmittedDate
      sampleLesson {
        ...LessonFragment
      }
      sampleLessonId
      scormCollectUserDetails
      seatPackages {
        ...SeatPackageFragment
      }
      seatTiers {
        ...SeatTierFragment
      }
      seatsAllocatedCount
      seatsLimit
      seatsLimitMet
      seatsUsedCount
      sections {
        ...SectionFragment
      }
      sessionIsTitled
      showProgress
      showSyllabusWhileUnenrolled
      sku
      slug
      status
      suggestedRetailPriceInCents
      superquizEnabled
      syllabusTitlesEnabled
      taxCategory
      taxable
      termsBlock
      title
      topicGroup
      updatedAt
      waitlistActive
      waitlistCount
      waitlistingEnabled
      waitlistingTriggered
      webinarDates {
        ...DateRangeFragment
      }
      webinarDetails {
        ...WebinarBlockFragment
      }
      webinarId
      webinarTimeZone
      workbookEnabled
    }
    courseId
    createdAt
    forgiven
    grade
    id
    linkedWorkbook
    originalGrade
    passed
    poolLabelByQuestionId
    questions {
      addAndDeleteRowsEnabled
      additionalContent
      body
      choices {
        ...QuestionChoiceFragment
      }
      copyAnswerFromAssessmentId
      copyAnswerFromQuestionId
      displayOption
      fileSubmissionAsset
      gradedAsCorrect
      hasChoices
      isBooleanChoice
      isBooleanChoiceOrMultipleChoice
      isEssay
      isFileSubmission
      isImageComparison
      isLikert
      isMultipleChoice
      isOpenEnded
      isOpenEndedOrEssay
      isSelectBoxes
      isTable
      mustSelectAllCorrectChoices
      openEndedResponse
      parentQuestion
      placeholder
      postText
      postText2
      postTextDisplayOption
      postTextDisplayOption2
      preText
      preText2
      preTextDisplayOption
      preTextDisplayOption2
      preselectedChoices {
        ...QuestionChoiceFragment
      }
      questionCategoryId
      questionId
      questionType
      required
      response
      scormInteractionType
      selectedChoice {
        ...QuestionChoiceFragment
      }
      selectedChoiceOrNoChoiceAvailable
      shouldCheckAnswers
      shouldDisplayOnResults
      table {
        ...QuestionTableFragment
      }
      tableResponse {
        ...QuestionTableFragment
      }
      type
    }
    questionsWithChoicesCount
    status
    timeElapsedInSeconds
    topic {
      failMessage
      id
      originalId
      passMessage
      postTextBlock
      preTextBlock
      questionSkipEnabled
      quizQuestions
      resultsMessage
      title
      type
      updatedAt
    }
    topicId
    topicType
    unansweredQuestionsCount
    updatedAt
    user {
      abbreviatedName
      accessedFlows
      activeLicense {
        ...LicenseFragment
      }
      address1
      address2
      adminClients {
        ...ClientFragment
      }
      allocatedLearningPaths {
        ...AllocatedLearningPathFragment
      }
      allocatedLicenses {
        ...AllocatedLicenseFragment
      }
      asset
      attendedMeetings {
        ...UserAttendedMeetingFragment
      }
      availableCoursesCount
      balance
      bio
      certificatesCount
      city
      client {
        ...ClientFragment
      }
      clientId
      collaborationsCount
      completedCoursesCount
      country
      createdAt
      customFields
      disabled
      email
      externalCustomerId
      firstName
      id
      invitedByName
      lang
      lastActiveAt
      lastInitial
      lastName
      learnerUserId
      managerUserId
      mustVerifyEmail
      name
      purchasedBundles {
        ...PurchasedBundleFragment
      }
      purchasedCourses {
        ...PurchasedCourseFragment
      }
      recommendedSlugs {
        ...UserRecommendedSlugFragment
      }
      recommendedTags {
        ...UserRecommendedTagFragment
      }
      ref1
      ref2
      ref3
      ref4
      ref5
      ref6
      ref7
      ref8
      ref9
      ref10
      roleKey
      sfAccountId
      sfContactId
      shippingName
      shouldHighlight
      startedCoursesCount
      state
      stripeCustomerId
      telephone
      twoFactorEnabled
      updatedAt
      waitlistedCourses {
        ...WaitlistedCourseFragment
      }
      zipCode
    }
  }
}
Variables
{
  "assessmentAttemptId": "4",
  "completedAssessmentAttemptId": 4
}
Response
{
  "data": {
    "MergeAssessmentAttemptIntoComplete": {
      "adminUpdatedGrade": true,
      "answeredQuestionsCount": 123,
      "answers": [AssessmentAnswer],
      "assessment": Assessment,
      "assignmentSubmissionId": 4,
      "correctQuestionsCount": 987,
      "course": "course-1",
      "courseId": "course-1",
      "createdAt": "2007-12-03",
      "forgiven": false,
      "grade": 987,
      "id": 4,
      "linkedWorkbook": "4",
      "originalGrade": 123,
      "passed": false,
      "poolLabelByQuestionId": {},
      "questions": [QuizQuestion],
      "questionsWithChoicesCount": 123,
      "status": "finished",
      "timeElapsedInSeconds": 987,
      "topic": Topic,
      "topicId": 4,
      "topicType": "ad",
      "unansweredQuestionsCount": 987,
      "updatedAt": "2007-12-03",
      "user": User
    }
  }
}

OrderBookmarkFolders

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns [String!]

Arguments
Name Description
ids - [ID!]

Example

Query
mutation OrderBookmarkFolders($ids: [ID!]) {
  OrderBookmarkFolders(ids: $ids)
}
Variables
{"ids": ["4"]}
Response
{
  "data": {
    "OrderBookmarkFolders": ["xyz789"]
  }
}

RedeemRegistrationAndRedemptionCodes

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Arguments
Name Description
validatedRedemptionCodes - [String!]!

Example

Query
mutation RedeemRegistrationAndRedemptionCodes($validatedRedemptionCodes: [String!]!) {
  RedeemRegistrationAndRedemptionCodes(validatedRedemptionCodes: $validatedRedemptionCodes) {
    redeemed
  }
}
Variables
{"validatedRedemptionCodes": ["abc123"]}
Response
{"data": {"RedeemRegistrationAndRedemptionCodes": {"redeemed": false}}}

ReinstateUserCourse

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation ReinstateUserCourse($id: ID!) {
  ReinstateUserCourse(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"ReinstateUserCourse": "4"}}

ReinstateUserLearningPath

Description

The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns an ID

Arguments
Name Description
id - ID!

Example

Query
mutation ReinstateUserLearningPath($id: ID!) {
  ReinstateUserLearningPath(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"ReinstateUserLearningPath": "4"}}

RemoveCommentLike

Description

Removed a like from a comment. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Boolean!

Arguments
Name Description
commentId - ID! The ID of the Comment.
likeId - ID! The ID of the Like.

Example

Query
mutation RemoveCommentLike(
  $commentId: ID!,
  $likeId: ID!
) {
  RemoveCommentLike(
    commentId: $commentId,
    likeId: $likeId
  )
}
Variables
{"commentId": 4, "likeId": "4"}
Response
{"data": {"RemoveCommentLike": false}}

SelectCurrentUserActiveLicense

Description

Changes the active license of the CurrentUser. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

Response

Returns a Boolean!

Arguments