What we’ll cover:
Applicable Roles:
-
HR Connect Administrator
Quick Reference Links:
Getting Started with Role Assignments
Users need various roles to perform certain functions in the Cayuse system. The Role Assignments API will load Role Assignments for Users into the Cayuse system.
- Role records are matched based on username
- All column headers of the CSV are required, however the value for the column is not required (unless specified).
-
Blank Rows are ignored in csv upload
-
If a field is not required, then user has the ability to update a value to “blank/null” when the corresponding column header is there.
- Deleting records is not supported at this time.
- Columns in the Roles Bulk Load Template can be uploaded in any order. The file will automatically map the header to match the column during the upload process.
API
Request:
Type |
Value |
Protocol |
HTTPS |
Method |
POST |
URL |
/api/v2/administration/batch/upload/role |
Example Call to Upload the Template::
curl -H "Authorization: Bearer $AUTHORIZATION_TOKEN"
-X POST
-F "file=@$PATH_TO_CSV_FILE"
"https://$HOST/api/v2/administration/batch/upload/role"
Response (Json String):
Name |
Type |
Description |
jobId |
UUID |
Identifier for the job to query status or get the report |
Example:
{"jobId":"66c586ae-31cb-47a9-9155-bf76460a3bec"}