Bulk API (User & OU)

With this enhancement, a new Bulk API is available for user and organizational unit (OU) loads. Bulk APIs provide organizations the ability to leverage a highly scalable and resilient framework to create and update data in Cornerstone via APIs.

  • It is optimized for loading large data sets in an asynchronous, queued model. It is ideal for bulk load use cases where there is a need to create or update data into your Cornerstone portal using APIs. For example, you can use Bulk APIs to keep employee and OU data in sync from your HRIS into Cornerstone.
  • It supports the OAuth 2.0 authentication framework released in August 2019.
  • It supports the portal configurations including custom fields, custom employee relationships, and availability settings for custom fields.

Use the API to retrieve the status of your loads as well as obtain a full report of the load performed including errors and warnings. Additionally, all the loads performed using the Bulk API are visible in a new Bulk API History page in Edge. The Bulk API History page is only visible to users who have the new Access Edge Bulk API History permission. Additional load-type specific permissions control the downloading of reports from the history page.

How Does this Enhancement Benefit My Organization?

This API enables organizations to keep their employee and organizational unit (OU) information in Cornerstone up-to-date by loading data in bulk with a modern, scalable REST API.

API Explorer

Documentation for all available APIs is available in the API Explorer.

Considerations

  • Organizations using Cornerstone HR cannot use the Bulk API to load employee data since effective dating is not yet supported by the Bulk API.
  • SPII fields and secure custom fields are not supported by the Bulk API.
  • There are new OAuth 2.0 scopes for Bulk API endpoints which is visible while registering a new OAuth 2.0 application or modifying an existing OAuth 2.0 application. Organizations with existing OAuth 2.0 applications must explicitly select the Bulk API scopes before utilizing the Bulk API endpoints.

Implementation

Organizations can self-activate the Bulk API for users and OUs via the Edge Marketplace in Pilot and Stage environments.

Organizations wanting to use the Bulk API in Production must submit a purchase inquiry via the Edge Marketplace. See Edge API - Purchase Inquiry.

The Access Edge Bulk API History permission is assigned the System Administrator role by default. The remaining new permissions are enabled upon activation. Additional documentation is available in the API Explorer upon release of the Bulk API.

Permissions

The following new permissions apply to this functionality:

PERMISSION NAME PERMISSION DESCRIPTION CATEGORY
Access Edge Bulk API History Grants access to the Bulk API History page, which displays all the loads that have been performed using the Bulk API. Administrators can select a load to view additional details of the load, including the results. This permission cannot be constrained. This is an administrator permission. Edge
Access Edge Bulk API

Grants ability to access and utilize the Bulk API. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Cost Center OU

Grants ability to use the Bulk API to load cost center organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Custom OU

Grants ability to use the Bulk API to load custom organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Division OU

Grants ability to use the Bulk API to load division organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Employee

Grants ability to use the Bulk API to load employee data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Grade OU

Grants ability to use the Bulk API to load grade organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Legal Entity OU

Grants ability to use the Bulk API to load legal entity organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Location OU

Grants ability to use the Bulk API to load location organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge
Bulk API - Position OU

Grants ability to use the Bulk API to load position organizational unit (OU) data. This permission cannot be constrained. This is an administrator permission.

This permission is only available when the Bulk API is enabled via Edge Marketplace.

Edge

Security Roles

Upon release, the Edge Bulk API History permission is automatically granted to the default System Administrator role. Administrators must grant this permission with the appropriate constraints to other roles, if necessary.

The remaining new permissions are disabled until the Bulk API is enabled through Edge Marketplace, at which time they are granted to the default System Administrator role.