Documentation
What's NewUKG.comMarketplaceUKG Pro status

Cascade Profile Assignments - Aggregated

Cascading profiles contain cascading policies, which define the paycodes used to trigger cascading accrual takings. Employees can have one or more policies in their profile, which is assigned by Accruals and Leave in People Information.

Prerequisites

A person ID is the same identifier as personKey and employee ID, and is not the same as a person number.

Example

In this example, we assign, verify, delete, and pass a request that makes no change to multiple people's cascade profile assignments.

Create or update assignments

The create or update request:

  • uses personIdentity to identify the person using their person number
  • uses cascadeProfile inside personAssignments to define the cascade profile to assign

Note: Cascade profile assignments are not effective dated.

Example request

Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.

[
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {
                "unAssignExisting":true,
                "assignmentProfile": "a-VACPER-Casc-Profile"
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {
                "assignmentProfile": "a-VACPER-Casc-Profile"
            }
        }
    }
]

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {
                "assignmentProfile": "a-VACPER-Casc-Profile"
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {
                "assignmentProfile": "a-VACPER-Casc-Profile"
            }
        }
    }
]

Verify assignments

You can use the bulk multi-read operation to verify assignments for multiple people at once.

Example request

To verify, call POST /v1/commons/persons/assignments/multi_read with the following request payload.

{
  "where": {
    "employees": {
      "key": "personNumber",
      "values": [
        "10020",
        "10030"
      ]
    },
    "personAssignments": [
      "cascadeProfile"
    ]
  }
}

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {
                "assignmentProfile": "a-VACPER-Casc-Profile"
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {
                "assignmentProfile": "a-VACPER-Casc-Profile"
            }
        }
    }
]

Make no change to assignments

When working with large numbers of people, you may wish to pass a request payload that makes no changes to a person's cascade profile assignments.

In the following example, the system makes no changes. Setting a null assignmentProfile and passing the unAssignExisting Boolean as false both result in no changes to a person's assignments.

Example request

Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.

[
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {
                "assignmentProfile":null
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {
                "unAssignExisting":false
            }
        }
    }
]

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {}
        }
    },
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {}
        }
    }
]

Delete assignments

You can delete, or unassign, cascade profile assignments. To delete our example's cascade profile assignments, call POST /v1/commons/persons/assignments/multi_upsert using the unAssignExisting property.

Example request

Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.

[
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {
                "unAssignExisting":true
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {
                "unAssignExisting":true
            }
        }
    }
]

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "cascadeProfile": {}
        }
    },
    {
        "personIdentity": {
            "personNumber": "10020"
        },
        "personAssignments": {
            "cascadeProfile": {}
        }
    }
]

Note: You can verify that the assignments were deleted by calling POST /v1/commons/persons/assignments/multi_read with a request payload specifying all of the affected person identities.

Updated over 1 year ago