A Guide to Aggregated Person Assignments

Aggregated person assignments currently supports the following 27 person assignments:

Prerequisites

A person's person ID is the same as the personKey and employee ID, and is not the same as the person number.

Retrieve all supported assignment names

Call GET /v1/commons/persons/assignments/names to retrieve a list of the names of all supported person assignments.

The response returned resembles the following example.

[
    "cascadeProfile",
    "processProfile",
    "scheduleEmployeePreference",
    "scheduleGroup",
    "attendanceAdmin",
    "schedulerWorkerType",
    "adjustmentRule",
    "managerPatternTemplateProfile",
    "skills",
    "leaveAdmin",
    "minorRule",
    "attestationProfile",
    "managerScheduleGroupProfile",
    "leaveProfile",
    "employeeTags",
    "attendanceProfile",
    "employeePreferences",
    "employeeJobPreferences",
    "scheduleRuleSet",
    "payCodeValue",
    "certifications",
    "percentageAllocationRule",
    "forecastingCategory",
    "scheduleRuleOverrides",
    "employmentTerms",
    "managerShiftTemplateProfile"
]

Retrieve all assignments for one person

Call GET /v1/commons/persons/assignments/{id} to return a list of all the assignments currently assigned to a single person.

The response returned resembles the following example.

{
    "personIdentity": {
        "personNumber": "20165",
        "personKey": 100
    },
    "personAssignments": {
        "cascadeProfile": {},
        "processProfile": {
            "employeeProcessProfileName": "EmpProcessProfile",
            "managerProcessProfileName": "EmpProcessProfile"
        },
        "scheduleEmployeePreference": {
            "zone": {}
        },
        "scheduleGroup": {
            "assignments": []
        },
        "scheduleRuleSet": {
            "scheduleRuleSetAssignments": []
        },
        "attendanceAdmin": {},
        "payCodeValue": {},
        "adjustmentRule": {},
        "percentageAllocationRule": {},
        "forecastingCategory": {
            "assignmentProfile": {
                "id": -2,
                "qualifier": "Empty Profile"
            }
        },
        "leaveAdmin": {},
        "minorRule": {
            "emancipatedMinor": false
        },
        "attestationProfile": {
            "attestationProfileAssignments": []
        },
        "leaveProfile": {},
        "attendanceProfile": {}
    }
}

Manipulate assignments for one or more persons

To modify one or more assignments for one or more people, use the following bulk operations:

POST /v1/commons/persons/assignments/multi_upsert
POST /v1/commons/persons/assignments/multi_read

Refer to the following topics for examples of creating, updating, verifying, and deleting (unassigning) all of the assignments supported by this API resource. These examples also include the proper method for ensuring no change happens to assignments.