What we’ll cover:
Applicable Roles:
-
HR Connect Administrator
Quick Reference Links:
Getting Started with Internal Associations
Internal Associations represent a relationship between a Person and a Unit. The Internal Associations API will load the internal associations between a Person and Unit object into the Cayuse system.
- Not all column headers and values are required in the .csv, unless specified. Any non-required column headers can be removed from the import file and no changes will be made to those fields upon import.
- Columns in the Internal Association Bulk Load Template can be uploaded in any order. The file will automatically map the header to match the column during the upload process.
-
Internal Association records are matched based on one the following data:
- Username + Unit Primary Code +Title
- EmployeeId + Unit Primary Code +Title
-
When a column header is not required, a blank/null field value will be respected during the import process for the columns in the following sections:
- Appointment Type
- Appointment (matched on Username or employee ID, along with unit primary code and Title in the import.)
- ERA Roles (Default = False)
- Contact (if adding Contact section, an email address is required at a minimum)
- Performance Site
-
When updating Internal Association data:
- If there is a column header with a null value associated row, the data in admin will be erased.
- If there is not a column header included in the .csv file the erase/null field data for that row will not be erased.
- Values provided will be merged into the existing records with the Cayuse system.
- Deleting records is not supported at this time.
- All blank rows will be ignored in the .csv import process.
- Special characters are accepted in Internal Associations in accordance with the RFC Standard Parser.
Learn more about updates to Internal Associations.
API
Request:
Type |
Value |
Protocol | HTTPS |
Method | POST |
URL | /api/v2/administration/batch/upload/affiliation |
Example:
curl -H "Authorization: Bearer $AUTHORIZATION_TOKEN"
-X POST
-F "file=@$PATH_TO_CSV_FILE"
"https://$HOST/api/v2/administration/batch/upload/affiliation
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"}