Skip to main content

HR Connect: Status of Upload Job

Emily Yeomans

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>
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 $AUTHORIZATION_TOKEN" \
-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 $AUTHORIZATION_TOKEN" \
-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 $AUTHORIZATION_TOKEN" \
-X GET \
"https://$HOST/api/v2/administration/batch/status/affiliation?jobId=$JOB_ID"

Response for People, Internal Associations and Units, Ad Hoc Teams, Ad Hoc Team Assignments, External Organizations, External Associations, Fringe Rates, Role Assignments, Training Types, and Trainings and Certifications:

Type Value Description
totalRowCount Number Total number of rows in upload
completed Boolean True if upload was completed
status String Started/Processing/Completed/Failed
jobId String 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, the Org Units upload is all-or-nothing. If any record in the file is invalid, the entire file will be rejected and no records will be loaded. All rows will be reported as errors in the upload report.

 

 

Related articles