Changelog
The following changes to the API are categorized by release. These changes are also reflected in the documentation.
September 2022
Fixed
- The xAPI formerly reported the Pathway in which a content item was completed. We fixed a bug that stopped that from happening. (PD-77722)
August 2022
Removed
- The Groups endpoint formerly returned
null
formodified-at
because Degreed does not log this data. This attribute has been removed. This is technically a breaking change. We hope that nobody was using thenull
value and apologize for any inconvenience. We will not make a habit of breaking changes.
New
- The
/skill-plans
endpoint now supports retrieving, adding, and deleting collaborators on a Skill Plan.
Documentation
- Updated required fields for Content - Courses endpoint.
- Updated Update a Specific User endpoint to indicate that
profile-visibility
cannot be modified. - Updated Create a New Opportunity endpoint to indicate that
start-date
andduration
are required.
July 2022
Fixed
- When a completion POST is executed, the response body correctly notes the time the request was submitted as the resource creation time. (PD-76491)
- The API now presents the correct skill target ratings when retrieving a Skill Plan. (PD-77149)
- The error messaging for the Opportunities endpoint is now improved. (PD-77171)
Documentation
- Added
X-Degreed-Organization-Code
header to endpoints that work with GAT. - Added
filter[term]=<keyword>
query parameter filter for GET ALL Content endpoints. The filter criteria returns content that contains the keyword in the title, summary, or labels.
June 2022
New
- The
/skill-plans
endpoint now supports creating, modifying, and deleting a Skill Plan. - The
/pathways
endpoint now supports creating, modifying, and deleting a Pathway.
Documentation
- Added
duration
anddate
attributes to Event content items. - Updated description for
daily-logins
in Get a Specific User.
May 2022
Fixed
- We resolved an issue that caused the API’s Skills endpoint to time out unexpectedly. (PD-74126)
- We resolved an issue that prevented using the API to add Skills to Podcast content items. (PD-73821)
- We improved the error message that displays when you try to create a completion via the API but do so incorrectly. (PD-73643)
- We resolved an issue that prevented the date and duration information of an Event from being accessible via the API. This information is now accessible via the API.
Note: this bug did not pertain to events with specific times of day, which are not yet supported by the API. (PD-74415, PD-75282)
Documentation
- Added
Next
parameter to Get Required Learning for a Specific User. - Added required body parameters to Delete Skills from Content.
- Updated description for
is-endorsed
. - Added
refresh_token
to Logout endpoint.
March 2022
New
- New API Developer Portal released.
- Opportunity endpoint added.
January 2022
New
- Added
rater-id
attribute to the Create a New Skill Rating endpoint and support for additional rating types ofpeer
andself
. - Added rater relationship to Get All Skill Ratings and Get a Specific Skill Rating endpoints.
- Added
filter[content_only]
query parameter to the Get All Views endpoint.
November 2021
New
- Added
is-active
attribute to the Get All Providers and Get a Specific Provider endpoints. - Added
filter[is_active]
query parameter to the Get All Providers endpoint. - Added
filter[most_recent]
query parameter to the Get All Skill Ratings endpoint.
Fixed
- Delete Skills from content returns a 204 on success as documented.
- Prevent in-active provider's content from being returned in the api for content endpoints.
- Add collaborators relationship to Get a Specific Skill Plan.
- On specific content endpoints the
filter[internal_only]
is applied when using thefilter[external_id]
query parameter. - Allow all completions for provider content to be returned in the api.
Documentation
- Update documentation to describe date filters available on content endpoints.
- Update documentation to include
target-rating
andis-endorsed
attributes on user skills endpoints.
October 2021
New
- Allow content restricted to visibility groups to be returned in the content endpoints.
Fixed
- Update documentation to describe date filters available on content endpoints.
September 2021
New
- Allow visibility groups to be set when you create content.
- Allow retrieval or replacement of visibility groups for content items.
August 2021
New
- Added
first-login-at
,last-login-at
,total-points
, anddaily-logins
attributes to Get All Users and Get a Specific User - Added
status
attribute to Get All Required Learning Items, Get a Specific Required Learning and Get Required Learning for a Specific User - Added
status
filter to Get All Required Learning Items and Get Required Learning for a Specific User
July 2021
New
- Added
internal_only
flag to the Get All Content, Get All Articles, Get All Books, Get All Videos, Get All Courses, Get All Assessments and Get All Podcasts - Added
requirement
attribute to Get A Specific Pathway resources
June 2021
New
- Added
external-id
andtags
as object extensions to statements in the xAPI.
May 2021
New
- Create A New Completion and Get a Specific Completion support creating and retrieving completions within the Global Admin Tool organization structure. These endpoints also support content from Native Providers.
- List Skills endpoint added.
- Added plan information to grouping context for viewed and completed statements in the xAPI.
April 2021
New
- The Completions endpoint now supports tasks and podcasts.
- Expanded completion creation to allow Organization to create a completion for public content Create A New Completion.
- New disliked content statement for the xAPI.
March 2021
New
- Ability to include a manager user id for endpoints Create a New User and Update a Specific User
- New New skill rating statement for the xAPI.
Fixed
- When content is updated, if the PATCH request contains invalid data an error message will be returned. This affects PATCH requests for the following endpoints: Content: Articles, Content: Books, Content: Videos, Content: Courses, Content: Assessments, Content: Podcasts
February 2021
New
- Create, Update, and Read endpoints for Content: Books now supports the 'url' attribute.
- Ability to get group memberships by joined date with endpoint Get a List of Group Memberships
January 2021
Fixed
- Completion endpoints Get All Completions, Get a Specific Completion and Get Completions for a Specific User now return the
is-internal
boolean for the included content. - Creating new content now enforces the
external-id
requirement for all content.
Updated about 1 year ago