What we’ll cover:
Applicable Roles:
-
HR Connect Administrator
Quick Reference Links:
Getting Started with Upload Job
Please note: It is very important to ensure the <fileType> is always given in the request. The following <fileType> values are acceptable:
- adhocteam
- adhocteamassignment
- affiliation
- affiliationFringeRate
- externalaffiliation
- extorg
- role
- training
- trainingtype
- unit
- user
API
Request:
|
Type |
Value |
| Protocol | HTTPS |
| Method | GET |
| Host | If your environment URL is OrgName.uat.cayuse.com, then the HOST variable should match and will also be OrgName.uat.cayuse.com. |
| URL | /api/v2/administration/batch/status/<fileType> |
| Header | X-Idp-New-Login: true |
| Query String Parameter | jobId=<ID of the Upload Job> |
Examples:
# Call to get the uploaded job status for a people and user job
curl -H "Authorization: Bearer $AUTHORIZATON_TOKEN" \
-H "X-Idp-New-Login: true" \
-X GET \
"https://$HOST/api/v2/administration/batch/status/user?jobId=$JOB_ID"
# Call to get the uploaded job status for a unit job
curl -H "Authorization: Bearer $AUTHORIZATON_TOKEN" \
-H "X-Idp-New-Login: true" \
-X GET \
"https://$HOST/api/v2/administration/batch/status/unit?jobId=$JOB_ID"
# Call to get the uploaded job status for an affiliation job
curl -H "Authorization: Bearer $AUTHORIZATON_TOKEN" \
-H "X-Idp-New-Login: true" \
-X GET \
"https://$HOST/api/v2/administration/batch/status/affiliation?jobId=$JOB_ID"
Response for Other Endpoints (Json String), including Ad Hoc Teams, Ad Hoc Team Assignments, External Organizations, External Associations, Fringe Rates, Role Assignments, Training Types, and Trainings and Certifications:
|
Type |
Value |
Description |
| rowsCompleted | Number | Number of rows already completed |
| errors | Number | Number of rows with errors |
| totalRowCount | Number | Total number of rows in upload |
| completed | Boolean | True if upload was completed |
| successes | Number | Total successful uploads |
| Query String Parameter | jobId=<ID of the Upload Job> |
Example:
“rowsCompleted”: 2,
“errors”: 2,
“successes”: 0,
“totalRowCount”: 2,
“completed”: true
Response for People, Internal Associations and Units (Json String):
|
Type |
Value |
Description |
| totalRowCount | Number | Total number of rows in upload |
| completed | Number | True if upload was completed |
| status | Number | Started/Processing/Completed/Failed |
| jobId | Boolean | ID of the uploaded job |
| successes | Number | Total successful uploads |
| errors | Number | Total file errors |
Example:
“totalRowCount”: 2,
“errors”: 2,
“successes”: 0,
“completed”: true,
“status”: “Completed”,
“jobId”: “471c1547-2030-4f57-942d-705e5499696a”
Please note: Due to hierarchy dependencies when loading Units, invalid records will be counted as errors, although the entire file would be considered a fail.