API (Web Services) Technical Specifications

Cornerstone's custom authentication framework, Session Token Service (STS), will be deprecated in February 2020 and will be fully retired and unavailable in February 2021. During the deprecation phase, Cornerstone will stop supporting STS. The STS endpoint will still be available during the deprecation phase, but Cornerstone will no longer address any defects or enhance this endpoint. Any requests to the endpoint will fail starting February 2021, when STS is fully retired.

Organizations will need to modify their code for existing integrations that use Cornerstone's API and switch to OAuth 2.0 from STS by February 2021. This only impacts Cornerstone's RESTful APIs, which includes the following:

  • Cornerstone's Foundational APIs (i.e. Cornerstone REST services)
  • Reporting API
  • Employee API (i.e. Cornerstone Core/CHR services)
  • Express Class API
  • Job Application API

This page displays a list of available APIs (web services).

All API technical specifications are available within the Edge API Explorer. To access the API Explorer, go to Admin > Tools > Edge > API Explorer.

PERMISSION NAME PERMISSION DESCRIPTION CATEGORY
Edge Develop - API Explorer Grants access to the API Explorer, which provides access to help documentation for various API applications. Edge

Additional permissions may be required for each API. These permissions are listed in the API specification within the Edge API Explorer.

Core APIs

REST API Name Description
Approvals This API enables users to view, approve, and deny requests on the user's Universal profile page. Using the Approvals API, users can review and manage approvals for offer letters, compensation, development plans, and more.
Global Search Global Search - The purpose of this service is to Get People,Training,Certification details.
OU Get OUs - The purpose of this service is to get OU details.

Learning and Extended Enterprise APIs

REST API Name Description
Catalog Search Catalog Search - The purpose of the Global Search service is to search & retrieve training data as per the search criteria given in the input parameters of the request call. For example, a client can search for trainings by title, description, and provider name.
Certification Details Certification Details - The GetCertificationDetails rest service allows an Active user to drill down and obtain a Ceritfication LO’s meta-data. The rest call will only be for one Certification LO.
Certification Transcript Transcript Details - The GetCertificationTranscript rest service allows you the ability to retrieve users’ certification transcript information from the Learning Management System (LMS). Data retrieved is based on the permissions assigned to the web service account requesting the information.
Certification Delete Certification - The purpose of the service is to remove certifications that are assigned to users.
Custom Field Custom Field - The Training Custom Field service allows the client to load values to training custom fields at either the Learning Object (LO) level or the Transcript level. Custom field REST Service can either add new Custom value or update existing value of custom field.
LO Transcript Transcript Search - The Transcript Search service gives you the ability to retrieve users’ transcript information from the Learning Management System (LMS).
LO

Create LO - The Create LO operation replicates the functionality of creating a new learning object in the Cornerstone LMS. All business rules configured in the portal are observed for this call. The actual payload can vary depending on the type of learning object.

Get LO - The Get Details operation allows the ability for an active user to drill down and obtain a learning object’s (LO’s) standard and custom field data.

Update LO - The Update LO operation replicates the functionality of creating a new learning object in the Cornerstone LMS. All business rules configured in the portal are observed for this call.
Proxy Enroll LO

Create - The Create Proxy Enrollment service enrolls users to a Learning Object (LO). This service can be used to enroll users in batches. The client will be able to Assign, Approve, Register, and Complete an LO. This service only supports the standard proxy type.

Get Status - The Proxy Enrollment Status service gets proxy enrollment statuses based on a given date range.

This API is scheduled for deprecation in February 2021.

Session Roster

Create - The purpose of this service is to allow clients, in real time, to update the session attendance roster as well as complete the session. The service is located at the following end points by environment.

Get Details - The purpose of this service is to allow clients to get the session attendance roster. Also this service is to get the details of Session roster for particular session. Service will provide all the details of particular session for which the Session ID or Locater ID is provided in request.
Training Unit Create Training Unit Assignment - The InsertTrainingUnitAssignment service operation replicates the functionality of creating new training unit assignments in the Cornerstone OnDemand (CSOD) Learning Cloud for extended enterprise (EXE) clients. All business rules configured in the portal are observed for this call.
Transcript and Task

Get Approvals - If approvals are used in the system and the user is a manager or approver, this represents the pending approvals for his or her subordinates. If this XML element is not included in the request, no items awaiting approval will be returned in the response message.

Get Assigned Trainings - This service returns all the transcripts assigned to Users, along with their statuses and due dates as applicable.

Get Inbox Items - This has no fields or attributes, it retrieves all items in the user’s inbox as shown on the welcome page. It represents a summary result set of other modules.

Get Sessions - Get upcoming sessions

Get Suggested Training - This report returns required and suggested Learning Objects have been added to user's transcripts by Admins or portal workflows.

Get Tasks - Represents all incomplete tasks assigned to the user. If this XML element is not included in the request, no tasks will be returned in the response message.

Get Transcripts - This Service represents all transcript items currently in the user’s transcript. Each response can return a maximum of 50 transcript records. There is a pageNumber attribute that can be incremented to get the next batch of 50 transcript records.

Performance APIs

REST API Name Description
Goal

Create - The purpose of this service is to create goals.

Details - The purpose of this service is to get user goal details.

Update - The purpose of this service is to update user goal.
Performance Review Get Details - This service enables administrators to extract performance review ratings, goals, and competency data that is associated with a performance review task within a specified time period. In order to use this service, administrators need to send a performance review task name or task ID. The service returns records for all users that are assigned the task. The service also includes each rating for each review step as well as comments.

Recruiting APIs

REST API Name Description
Recruiting

Get Job Applicant - This service is designed to pull ATS Job Applicant master data from CSOD in real time. The purpose of this service is to allow clients retrieve candidate information from the CSOD application. Client will call this service and specify an applicant status and other search criteria retrieve the user information.

Get Job Requisition Ad Details - The purpose of this service is to get Job Requisition Ad details based on the input job requisition ref value.

Get Job Requisition Custom Field - The purpose of this service is to get Job Requisition Custom Fields data as per the search criteria given in input parameter.

Get Job Requisition - This service is designed to pull ATS Job Requisition master data from CSOD in real time.

Update Job Applicant Status - This service is designed to change the status of a job applicant.

Reporting

API Name Description
Reporting The Reporting API is a public facing web service that allows clients read-only access to their Cornerstone data via the Real Time Data Warehouse (RTDW). It adheres to the OData protocol (http://www.odata.org/) and dynamically adjusts to reflect any client's schema. Currently, it allows access to all the reporting views in the report schema (report.vw_rpt_*), which are the data source for custom reporting in the Cornerstone application.

To provide better API functionality and experience, Cornerstone is moving from SOAP to REST APIs. Click here to view available SOAP APIs.

Webservice API API API API API API Web Services Web Services Web Services