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"

Upload Job Status values

Once Cayuse receives your upload and creates an upload job, the Job Status will indicate processing details until the job has a terminal status. 

Job Status Description
Started The upload job has been received and is queued to process.
Processing The upload job is processing.
Completed The upload job finished. Check successes and errors in the response for details.
Failed The upload job stopped due to a processing error and did not complete.
Terminated In rare cases, if the system restarts mid-job, the job is marked Terminated. If you see this status, resubmit the file.

As not all of the above job statuses are applicable to all upload types, please see below for details on processing and specific statuses for each file type. 

Job Completion States by File Type

Please note: with the exception of the unit upload, if a job ends in a ‘Failed’ status partway through a file, any records that loaded successfully before the failure remain in the system — they aren't automatically removed. To confirm exactly which rows in your upload succeeded, download the Job Report, then correct and resubmit the rest.

File type How records are loaded Possible ending status
unit All-or-nothing. Due to hierarchy dependencies, the Org Units (unit) upload is all-or-nothing. If any record in the file is invalid, the entire file is rejected and no records are loaded. In this scenario, all rows are reported as errors in the upload report. Completed, Failed, Terminated
user

Row-by-row — each record loads independently.

Please note: Row-level errors in a user upload won't cause the job to end in a ‘Failed’ status — it will still report as ‘Completed’. Check the errors and successes counts, or download the Job Report, to see which individual rows did not load.

 Completed, Terminated
affiliation Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
role Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
extorg Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
affiliationFringeRate Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
externalaffiliation Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
training Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
trainingtype Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
adhocteam Processed sequentially in batches containing up to 1,000 records each. Completed, Failed
adhocteamassignment Processed sequentially in batches containing up to 1,000 records each. Completed, Failed

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 Current Upload Job status. See Upload Job Status Values for descriptions of each possible value.
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”

 

 

Related articles