Transcript and Task (Legacy)
Use this API to retrieve a user's transcript and task data from Cornerstone Learning.
- All business rules configured in your Cornerstone portal are observed by this API.
- You can only retrieve data for Active users using this API.
- You can retrieve data for only one user per request. If you are looking to retrieve transcript data in bulk, consider using the Transcript Search API.
- Removed and archived transcript records cannot be retrieved using this API.
- This API does not include custom field data in the response.
Transcript API
The newer Transcript APIs are sharing the same scope (transcript:read) with the legacy "Transcript And Task" APIs to configure the Oauth authorization.
- GetAssignedTrainings - /services/api/TranscriptAndTask/Assigned
- GetSessions - /services/api/TranscriptAndTask/Session
- GetSuggestedTrainings - /services/api/TranscriptAndTask/Transcript
- GetTranscripts - /services/api/TranscriptAndTask/SuggestedTraining
While all new Transcript APIs are supporting row-level security (permissions/constraints) by default, this was not yet supported by the legacy "Transcript And Task" APIs.
transcript:read:legacyconstraint
Cornerstone will introduce a new additional claim (transcript:read:legacyconstraint) to support row-level security for legacy "Transcript and Task" APIs, to be aligned with the newer Transcript APIs.
Important: The Additional Scope will take effect after the March 2024 release.
| Configuration | Description |
|---|---|
| True | If set to true, the security permissions and constraints for legacy "Transcript And Task" APIs (as configured in the portal) will apply. This should be the default setting when the intention is to use the newer Transcript APIs only. |
| False | If set to false, the security permissions and constraints for legacy "Transcript And Task" APIs (as configured in the portal) will be ignored. This setting is about to achieve feature parity (compatibility) with existing integrations. Do not use this setting when the intention is to use the newer Transcript APIs only. |
Use Cases and Recommended settings
| Use Case | Additional Claim | Recommendation | Comments |
|---|---|---|---|
| Existing integration using legacy "Transcript And Task" APIs, no plans to use newer Transcript APIs | transcript:read:legacyconstraint | False | The integration should continue to work as of today (without row-security). |
| Use new Transcript APIs in parallel to legacy "Transcript And Task" APIs | transcript:read:legacyconstraint | True | Set the additional claim to True to align the (row-level) security model for the legacy "Transcript And Task" APIs with the newer Transcript APIs. Don't forget to properly assign the permissions and constraints to the user associated with the Oauth app, otherwise the legacy "Transcript And Task" APIs may stop to return data. |
| Use new Transcript APIs only, no plans to use legacy "Transcript And Task" APIs | transcript:read:legacyconstraint | True | Set the additional claim to True to align the (row-level) security model for the legacy "Transcript And Task" APIs with the newer Transcript APIs, even there are no plans to use the legacy "Transcript And Task" APIs. If the additional claim is not enabled, the integration can potentially query transcript related data without constraints (row-level security) using legacy "Transcript and Task" APIs. |
Get Transcripts
Use this endpoint to retrieve transcript records for a user.
OAuth 2.0 Scope: transcript:read
Permission: View Transcript Item (optional)
Localization
Localized Request Fields
- Status
Localized Response Fields
- Status
- LoType
- SubjectTitle
- Title
- LoProviderId
Get Tasks
Use this endpoint to retrieve all incomplete tasks assigned to the user.
OAuth 2.0 Scope: task:read
Localization
The response data will be in the language of the user in your query parameter unless you include the Language query parameter in your request.
Localized Response Fields
- Title
Get Approvals
Use this endpoint to retrieve the pending approvals for a manager or approver.
OAuth 2.0 Scope: approval:read
Localization
The response data will be in the language of the user in your query parameter unless you include the Language query parameter in your request.
Localized Response Fields
- ApprovalTitle
Get Assigned Trainings
Use this endpoint to retrieve all training assigned to a user, along with their statuses and due dates as applicable.
OAuth 2.0 Scope: transcript:read
Permission: View Transcript Item (optional)
Localization
The response data will be in the language of the user in your query parameter unless you include the Language query parameter in your request.
Localized Request Fields
- Status
Localized Response Fields
- Status
- Title
Get Inbox Items
This endpoint retrieves all items in the user’s inbox as shown on the Welcome Page widget in the Cornerstone UI.
OAuth 2.0 Scope: inbox:read
Localization
The response data will be in the language of the user in your query parameter unless you include the Language query parameter in your request.
Localized Response Fields
- Title
Get Sessions
Use this endpoint to retrieve the upcoming sessions in a user's transcript.
OAuth 2.0 Scope: transcript:read
Permission: View Transcript Item (optional)
Localization
The response data will be in the language of the user in your query parameter unless you include the Language query parameter in your request.
Localized Request Fields
- Status
Localized Response Fields
- Status
- Title
- Location
Get Suggested Training
OAuth 2.0 Scope:
Permission: View Transcript Item (optional)
Localization
The response data will be in the language of the user in your query parameter unless you include the Language query parameter in your request.
Localized Response Fields
- Title
- LoType