What we’ll cover:
Applicable Roles:
-
HR Connect Administrator
Before Getting Started
Prior to uploading your Org Units, please review the articles on Creating a Unit and troubleshooting tips and read the following:
Understanding the root unit: Every tenant loads with one unit already in the Unit table. This is the root unit. In the UI it is called the Institutional Root and the Primary Code is 1000 by default. Both the Primary Code and the Name may be changed by the customer. Do not import or update the root unit through HR Connect as it will result in an error. Instead, updates to the root unit can be made through the Admin UI.
Quick Reference Links:
Getting Started with Org Units
Units provide a hierarchical representation of the organizational structure. The Units API will load the organizational structure (Units) into the Cayuse system.
- All column headers of the CSV are required, however the value for the column is not required (unless specified).
- Values provided will be merged into the existing records with the Cayuse system.
- Deleting records is not supported at this time and only non-required field values can be removed.
The Primary Code column in the CSV file should be used as the unique Unit identifier when synchronizing your data with Cayuse. As you update your records, the Primary Code should always remain the same for each unit. If the Primary Code changes, a new Unit record will be created.
In most cases, an institution only needs to provide a Primary Code when loading units. This code should uniquely identify this unit in your enterprise Human Capital Management system. Typically, this code will also identify this unit in your enterprise Finance system as well. If your institution uses different codes to identify a unit in your HCM and Finance system, please use the Primary Code to indicate the code used in the HCM and the Secondary Code to indicate the code use in the Finance system. This information is important for other integration points with the Cayuse Research Platform, for example, when passing proposal or award data to your finance system to facilitate the post-award process.
This information is important for other integration points with the Cayuse Research Platform, for example, when passing proposal or award data to your finance system to facilitate the post-award process.
API
Request:
|
Type |
Value |
|
Protocol |
HTTPS |
|
Method |
POST |
|
URL |
/api/v2/administration/batch/upload/unit |
Example:
# Call to upload the CSV
curl -H "Authorization: Bearer $AUTHORIZATION_TOKEN"
-X POST 'https://$HOST/api/v2/administration/batch/upload/unit'
-F 'file=@"$PATH_TO_CSV_FILE"'
Response (Json string):
|
Name |
Type |
Description |
|
jobId |
UUID |
Identifier for the job to query status or get the report |
Example:
{"jobId":"66c586ae-31cb-47a9-9155-bf76460a3bec"}
Status Endpoints:
“totalRowCount”
“errors”
“successes”
“completed”
“status”
“jobId”
Updating Units
If you are updating parent/child relationships in existing Units, separate uploads may be required to achieve this call. Depending on your Unit structure, the amount of uploads could vary. For example, grandparent, parent, child, grandchild, etc may require several loads.
Example:
|
Current unit structure |
Root > Child 1 > Child 2 |
|
Expected unit structure |
Root > Child 2 > Child 1 |
|
Solution Steps |
|