Skip to main content

HR Connect: Download Job Report

Emily Yeomans
  • Updated

What we’ll cover:

Applicable Roles:

  • HR Connect Administrator

Before getting started:

Before requesting the job report, it may be helpful to check the job status to ensure that the job is complete. If you request the job report prior to the job completing, a job report will be generated for the partially completed job and you will not be able to generate a new report for the completed job.

Quick Reference Link:

Getting Started with Downloading Job Report

It can be helpful to check the job status to check that the job is complete before requesting the job report. If you request the job report prior to the job completing, a job report will be generated for the partially completed job and you will not be able to generate a new report for the completed job.

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/report/<fileType>

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 "X-Idp-New-Login: true" \
  -X GET \
"http://$HOST/api/v2/administration/batch/report/user?jobId=$JOB_ID"

Response CSV file for Ad Hoc Teams, Ad Hoc Team Assignments, External Organizations, External Associations, Fringe Rates, Role Assignments, Training Types, and Trainings and Certifications with the same columns as the Input File plus:

Name

Description

Timestamp

Timestamp when the record was processed

Status

Indicates if processing the record was successful or if the was an error

Error

If there was an error, descriptions of the error

Row ID

Internal Identifier

jobId

Identifier for the Job

 

Response CSV file for Unit with the same columns as the Input File plus:

Name

Description

jobId

Identifier for the Job

Status

Indicates if processing the record was successful or if the was an error

Error

If there was an error, descriptions of the error

 

Response CSV file for People with the same columns as the Input File plus:

Name

Description

jobId

Identifier for the Job

Status

Indicates if processing the record was successful or if the was an error

Error

If there was an error, descriptions of the error
Send Activation Email

 

 Indicates if activation email was sent during upload.

Please note: If you indicate Yes or No in the boolean fields (such as User Active) of an upload file, the response in the People report will show as True or False.

 

Response CSV file for Internal Association with the same columns as the Input File plus:

Name

Description

jobId

Identifier for the Job

Status

Indicates if processing the record was successful or if the was an error

Error

If there was an error, descriptions of the error

 

Error Message Troubleshooting Related to Units

While other errors may exist, this is one example of a complex scenario that may occur.

Error Message

Message Received:

"Record Import failed. Unit is part of a cycle."

Reason for Error:

This message displays when there is an attempt to upload a file with a cycle of units that are parents of each other. 

Suggested Resolution:

Ensure the cycle of units are not parents of each other and attempt to upload the file again.

 

Error Message Troubleshooting Related to Fringe Rates

Error Message

Message Received:

 "Affiliation for person 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' unit 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' and title '##########' not found"

Reason for Error:

Reason #1: A person's Internal Association with the given Unit and Title doesn't exist.

Reason #2: A time out occurred.

Suggested Resolution:

For Reason #1, verify the person's Internal Association have the given Unit and Title.

If Reason #1 is not the issue, please reload the specific failed Fringe Rates.

 

Related articles