HR Connect: External Organizations

What we’ll cover:

• Getting started with External Organizations
• API for External Organizations

Applicable Roles:

• HR Connect Administrator

Quick Reference Links:

• Status of Upload Job
• Download Job Report

Getting Started with External Organizations

Load external organizations into the Cayuse system. External Organizations are any entities that are not part of your institution that you may need to track for reporting and data reuse purposes. Most typically these are sub-awardees and sponsors.

Many institutions do not wish to use their HCM or Finance System as the system of record for external organizations. In that case, we recommend not using this API to synchronize data. This dataset is completely optional. If you choose to load data, the following guidance applies.

• 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.

The Primary Code column in the CSV file should be used as the unique identifier when synchronizing your external organization data with Cayuse. As you update your records, the Primary Code should remain the same. If the Primary Code changes, a new External Organization record will be created. 

In most cases, an institution only needs to provide a Primary Code when loading External Organizations. This code should uniquely identify this external organization in your enterprise Finance system. If you have multiple systems that track your external organizations and you need to track different identifiers for the same institutions, you can load an alternate code to the Secondary Code field as well. This information can be important for other integration points with the Cayuse Research Platform, for example when passing proposal or award data to your finance system to facilitate the post-award process.

API

Request:

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/extorg"

Response (Json String):

Example:

{"jobId":"66c586ae-31cb-47a9-9155-bf76460a3bec"}