What we’ll cover:
Applicable Roles:
-
HR Connect Administrator
Quick Reference Links:
Getting Started with External Associations
Use the following API to create an External Association.
- 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 and removing values are not supported at this time.
API
Request:
|
Type |
Value |
|
Protocol |
HTTPS |
|
Method |
POST |
|
URL |
/api/v2/administration/batch/upload/externalaffiliation |
|
Header |
Content-Type: text/csv |
|
Header |
X-Idp-New-Login: true |
|
Query String Parameter |
jobId=<ID of the Upload Job> |
|
Variable |
Password |
Example:
# Call to upload the CSV
curl -H "Authorization: Bearer $AUTHORIZATON_TOKEN" \
-H "Content-Type: text/csv" \
-H "X-Idp-New-Login: true" \
-X POST \
--data-binary "@$CSV_FILE" \
"https://$HOST/api/v2/administration/batch/upload/externalaffiliation"
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"}