Changelog
The GraphQL schema change log is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes, schema previews, and upcoming breaking changes.
Changes on 03-04-2021
- Moved
removeChannelContent
andeditChannel
toGR
- Added
startedOn
tocrAssessmentUserOptions
query.
Changes on 03-01-2021
Changes to crAssessmentUserOptions
query:
- Added
completedOn
field - Added
earliestCompletedOn
andlatestCompletedOn
filters
Changes on 02-26-2021
Added skillAssessmentId
to pathCatalog
query
Changes on 02-25-2021
Moved editChannel
mutation from ALPHA to BETA
Changes on 02-18-2021
Added currentSsoIdentifier
, createdOn
and note
fields to the following queries:
planAdmins
managersV2
Also moved planAdmins
and managersV2
queries from ALPHA to BETA
Changes on 02-12-2021
Updated query crAssessmentUserOptions
to add the following fields:
createdOn
lastUserInteractionOn
passFail
updatedOn
is now backed by a new internal field that gets updated when any change to the record. Previously it was backed by lastUserInteractionOn
, which we are now exposing separately.
Also removed the user
field.
Changes on 02-04-2021
Added the channelGroup
query in ALPHA
Added the priority
query in ALPHA
Move archiveChannel
mutation from BETA to GR
Added skillId
field to skillIqsSummary
query
Changes on 01-29-2021
Updated query crAssessmentUserScores
to add the following fields:
createdOn
lastCompletedOn
Updated query crAssessmentUserCompletions
with the following changes:
createdOn
,updatedOn
andcurrentSsoIdentifier
fields addedstartDate
andendDate
filters operate on the newupdatedOn
field (previously operated on thestartedOn
field)- Added filters for
completeOrIncomplete
andpassFailSkipped
Changes on 01-13-2021
Updated the query pathCatalog
to include levels
.
Changes on 01-11-2021
Added the addTeamsToChannels
mutation in ALPHA
Changes on 01-04-2021
Added the query pathCatalog
in ALPHA.
Made the following changes to the inviteMember
mutation:
- Added the field
teamIds
and deprecated the fieldteamId
on both the input and the payload types. - Added the field
planUserId
and deprecated the fieldinviteId
on the payload type.
Changes on 12-22-2020
Added courseIds
filter to courseProgress
and courseDailyUsage
queries.
Changes on 12-01-2020
Added the field note
to the input and payload types for the editUser
mutation.
Changes on 11-23-2020
- Added an
ownerIds
filter to thechannels
query. - Added an
isComplete
filter to thecontentProgress
query.
Added the following mutations in BETA:
archiveChannel
removeChannelContent
Changes on 11-19-2020
Added the following mutations in ALPHA:
addTeamMember
removeTeamMember
Changes on 11-17-2020
Added the planPermissionSets
query in ALPHA.
Changes on 11-16-2020
Added the field permissionSetId
in ALPHA to the input type for the addTeamManager
mutation.
Changes on 11-13-2020
Added the field parentTeamId
in ALPHA to the input and payload types for the addTeam
mutation.
Changes on 11-12-2020
Added memberInvitesV2
query in ALPHA. Changes (relative to the memberInvites
query) include:
- The
inviteId
field has been replaced withplanUserId
. teamId
is no longer availableisCanceled
is now available
Changes on 11-11-2020
Added managersV2
query in ALPHA. Changes (relative to the managers
query) include:
- The
id
field has been replaced withplanUserId
. - The query returns one record for each manager, and returns a list of all teams they manage (instead of returning a record for each manager-team instance).
Changes on 11-06-2020
Added Tags
entity with the following fields:
contentId
idNum
superDomain
domain
audience
primaryAtomic
: which includesname
andalternativeNames
Note: the above fields are currently in BETA (with the exception of contentId
and idNum
).
Also included within Tags
is the following deprecated fields:
tools
topics
audiences
certifications
primaryAtomicTags
Changes on 11-03-2020
Added planAdmins
query in ALPHA. Changes (relative to the admins
query) include:
- The
id
field has been removed.
Changes on 10-29-2020
Added the following fields to contentCatalog
:
imageUrl
duration
Changes on 10-27-2020
The following queries have been added in BETA:
crAssessmentFormLevelStatistics
crAssessmentItemLevelStatistics
crAssessmentOptionLevelStatistics
Changes on 10-26-2020
The following fields on the crAssessmentUserCompletions
BETA query have changed names:
tqTopic
is nowtopicName
testFormId
is nowformTaxonomy
A filter with startDate
and endDate
has been added to the crAssessmentUserCompletions
BETA query.
Changes on 10-23-2020
The query crAssessmentUserOptions
has been added in BETA.
Changes on 10-22-2020
The following BETA queries have changed names:
criterionAssessmentUserCompletions
is nowcrAssessmentUserCompletions
criterionAssessmentUserScores
is nowcrAssessmentUserScores
Changes on 10-20-2020
The field ssoIdentifiers
on the User
type has been deprecated. Use currentSsoIdentifier
instead.
Changes on 10-13-20
The query criterionAssessmentUserCompletions
has been added in BETA.
Changes on 10-09-20
The query criterionAssessmentUserScores
has been added in BETA.
Changes on 10-05-2020
Deprecated the following fields within Tags
in courseCatalog:
tools
topics
audiences
primaryAtomicTags
certifications
Note: Please see update on 08-28-2020 on new tag fields which are currently in BETA.
Changes on 09-10-2020
Released contentProgress
query to BETA.
Changes on 09-09-2020
- Replaced the
type
field onContentCatalogFilter
withcontentTypes
, which now takes a list ofContentCatalogType
. - Changed
ContentCatalogType
values to be capitalized.
Changes on 09-04-2020
Updated contentCatalog
to return only published content by default.
- Replaced
status
filter value withshowRetiredContent
Changes on 08-28-2020
Added the following fields within Tags
to the entity course
:
audience
domain
primaryAtomic
superDomain
Note these fields are currently in BETA.
Changes on 08-20-2020
Added isCourseCompleted
to CourseProgressFilter
for the entity CourseProgress
.
Changes on 08-19-2020
The field ssoIdentifiers
within UserFilter
has been changed to do an exact
search on the field currentSsoIdentifier
.
- It's prior behavior, to perform a fuzzy search on the field
ssoIdentifiers
. - You can still provide an array of ssoIdentifiers and will check for each.
The field updatedOn
has bee added to the following entities:
CourseDailyUsage
CourseProgress
Changes on 08-14-2020
Added a new query to the graph: contentCatalog
. This is currently in BETA.
Added Functionality
The addChannelContent
mutation now supports guides and skill assessments.
Schema Changes on 08-05-2020
The following mutations have been added:
editUser
Schema Changes on 08-04-2020
The following fields have been added to the addChannelMembers
mutation input:
ownerUserId
The following mutations have been added to GR:
addRole
editRole
Schema Changes on 07-30-2020
The SkillAssessmentCatalog
now has Topics and Subtopics.
Schema Changes on 07-22-2020
The input fields startDate
and endDate
have been added to the following input types:
CourseDailyUsageFilter
CourseProgressFilter
RoleIqLearnerLevelFilter
SkillAssessmentResultFilter
The input fields afterDate
and beforeDate
have been removed from the following input types:
RoleIqLearnerLevelFilter
The input fields afterDate
and beforeDate
have been deprecated on the following input types:
CourseDailyUsageFilter
CourseProgressFilter
SkillAssessmentResultFilter
Schema Changes on 07-21-2020
- The mutations
assignUsersToRole
andassignTeamsToRole
have been added to GR.
API General Release on 07-15-2020
Pluralsight's graphQL API is now in General Release. All API keys are automatically approved and tagged as GR.
Schema Changes on 07-15-2020
- The mutation
cancelInvite
has been added. - The field
lastLogin
has been added to theUser
type.
Schema Changes on 07-14-2020
- The query
team
has been added. - The field
retakeReasons
on theSkillAssessmentResult
type has been deprecated.
Schema Changes on 07-13-2020
The mutation addRole
has been added in alpha.
Schema Changes on 06-26-2020
Within AddChannelMembersInput
we are checking to see if the field instructions
is less than or equal to the 500 character limit.
Within AddChannelInput
we are checking the following field lengths:
description
<= 500 characters.name
<= 100 characters.objective
<= 100 characters.
Schema Changes on 06-23-2020
In SkillAssesmentResut
the following fields have been deprecated:
approximateLevel
Use quintileLevel instead.status
This field is being discontinued.
Added the nullable fields actorUserId
and skipNotificationsEmail
to AddChannelMembersInput
and AddChannelMembersPayload
within the AddChannelMembers
mutation.
Note the field actorUserId
will be required at a future point.
Schema Changes on 06-19-2020
The fields createdOn
and updatedOn
within roleIqCatalog have been changed from Date
to DateTime
.
Schema Changes on 06-18-2020
Added the nullable field instructions
to type AddChannelMembersInput
and AddChannelMembersPayload
.
The following queries have been added to the graph:
skillAssessmentResult
skillAssessmentResults
The following queries have been deprecated:
skillIqs
sillIq
Please use skillAssessment
and skillAssessments
Schema Changes on 06-17-2020
The following queries have been added to the graph:
skillAssessmentCatalog
added
The type Query skillCatalog
deprecated. Please use skillAssessmentCatalog
.
Schema Changes on 06-16-2020
The following fields have been added to the courseCatalog
:
averageRating
numberOfRatings
The field skillShortName
on the skillIqs
and skillIq
has been deprecated.
The following fields on skillCatalog
have been added:
description
Schema Changes on 06-09-2020
The field groupId
on the Team
type is now deprecated.
Schema Changes on 06-08-2020
The mutation removeUser
was added.
Schema Changes on 06-01-2020
The following fields have been added to the UserFilter
input type:
isCurrent
notes
ssoIdentifiers
emails
The following field has been deprecated on the UserFilter
input type:
onlyCurrent
Schema Changes on 05-26-2020
The mutation removeChannelMember
has been added.
Schema Changes on 05-21-2020
The mutation addChannelMember
has changed to addChannelMembers
and now has two additional fields: memberUserIds
and contributorUserIds
. It no longer supports receiving a single userId
.
Schema Changes on 05-13-2020
The following query has been added to the graph:
memberInvites
The following mutations has been added to the graph:
createUser
inviteMember
Schema Changes on 05-08-2020
The following query has been added to the graph:
roleIqsSummary
Schema Changes on 05-05-2020
The following queries have been added to the graph:
skillIqsSummary
The following fields have been added to the channels
and channel
queries:
memberCount
durationInSeconds
,durationInHours
averageCompletion
owner
lastActivity
Release stage changed on 04-22-2020
- The GraphQL API is now officialy in BETA.
Schema Changes on 04-15-2020
The following changes have been made to the schema:
- Added pagination to
skillCatalog
query - Added pagination to
channelMembers
query - Added pagination to
channelContent
query
Schema Changes on 04-14-2020
The following changes have been made to the schema:
- Added pagination to
roleIqSkills
query
Schema Changes on 04-13-2020
The following changes have been made to the schema:
- Added pagination to
roleIqAssignment
query
Schema Changes on 03-26-2020
The field course
was added to the following types:
CourseProgress
CourseDailyUsage
Schema Changes on 03-25-2020
The field user
was added to the following types:
CourseProgress
CourseDailyUsage
Schema Changes on 03-02-2020
The following changes have been made to the schema:
- The
roleIqCatalog
query now has an optionalRoleIqCatalogFilter
input, which allows filtering byname
.
Schema Changes on 02-07-2020
The following changes have been made to the schema:
- The
roleIqLearnerLevels
query has been added.
Schema Changes on 01-24-2020
The following changes have been made to the schema:
- On the
skillIqs
query, theafterDate
andbeforeDate
parameters were replaced with afilter
input object, which containsafterDate
andbeforeDate
.
Schema Change on 01-21-2020
The following changes have been made to the schema:
InteractiveCourse.ratingAverage
changed type fromInt
toFloat
Schema Change on 01-20-2020
The following changes have been made to the schema:
Course.releasedDate
andCourse.displayDate
changed type fromDate
toDateTime
Schema Change on 01-17-2020
The following changes have been made to the schema:
- The
interactiveCourseCatalog
query has been added