HRMS · Performance & Talent
Performance Reviews
Performance and potential are different axes, and conflating them is what makes a nine-box impossible to build later.
/api/hrms/performance-reviewsPublished as /api/v1/performance-reviewsDownload specification (OpenAPI 3.1) Screen: Performance Reviews
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Performance Reviews on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.performance_reviews · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/performance-reviewsList performance reviews
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overall_rating": "text",
"rating_value": "1250.00",
"potential_rating": "text",
"self_rating": "text",
"calibrated_rating": "text",
"calibrated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"strengths": "text",
"development_areas": "text",
"manager_comments": "text",
"employee_comments": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/performance-reviews?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/performance-reviews/{id}Read one performance reviews
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overall_rating": "text",
"rating_value": "1250.00",
"potential_rating": "text",
"self_rating": "text",
"calibrated_rating": "text",
"calibrated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"strengths": "text",
"development_areas": "text",
"manager_comments": "text",
"employee_comments": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-reviewsCreate a performance reviews
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
cycle_id | uuid | Yes | Cycle |
employee_id | uuid | Yes | Employee |
reviewer_id | uuid | No | Reviewer |
overall_rating | text | No | Overall rating |
rating_value | numeric | No | Rating value |
potential_rating | text | No | Potential rating |
self_rating | text | No | Self rating |
calibrated_rating | text | No | Calibrated rating |
calibrated_by | uuid | No | Calibrated by |
strengths | text | No | Strengths |
development_areas | text | No | Development areas |
manager_comments | text | No | Manager comments |
employee_comments | text | No | Employee comments |
triggers_pip | boolean | No | Triggers a performance plan |
merit_eligible | boolean | No | Merit eligible |
promotion_recommended | boolean | No | Promotion recommended |
status | text | No | Status Allowed: draft self_review manager_review calibration approval shared acknowledged closed |
submitted_at | timestamp with time zone | No | Submitted at |
acknowledged_at | timestamp with time zone | No | Acknowledged at |
Sample body
{
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overall_rating": "text",
"rating_value": "1250.00",
"potential_rating": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overall_rating": "text",
"rating_value": "1250.00",
"potential_rating": "text",
"self_rating": "text",
"calibrated_rating": "text",
"calibrated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"strengths": "text",
"development_areas": "text",
"manager_comments": "text",
"employee_comments": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-reviews" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","reviewer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","overall_rating":"text","rating_value":"1250.00","potential_rating":"text"}'PUT/api/hrms/performance-reviews/{id}Change a performance reviews
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
cycle_id | uuid | Yes | Cycle |
employee_id | uuid | Yes | Employee |
reviewer_id | uuid | No | Reviewer |
overall_rating | text | No | Overall rating |
rating_value | numeric | No | Rating value |
potential_rating | text | No | Potential rating |
self_rating | text | No | Self rating |
calibrated_rating | text | No | Calibrated rating |
calibrated_by | uuid | No | Calibrated by |
strengths | text | No | Strengths |
development_areas | text | No | Development areas |
manager_comments | text | No | Manager comments |
employee_comments | text | No | Employee comments |
triggers_pip | boolean | No | Triggers a performance plan |
merit_eligible | boolean | No | Merit eligible |
promotion_recommended | boolean | No | Promotion recommended |
status | text | No | Status Allowed: draft self_review manager_review calibration approval shared acknowledged closed |
submitted_at | timestamp with time zone | No | Submitted at |
acknowledged_at | timestamp with time zone | No | Acknowledged at |
Sample body
{
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reviewer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"overall_rating": "text",
"rating_value": "1250.00",
"potential_rating": "text",
"self_rating": "text",
"calibrated_rating": "text",
"calibrated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"strengths": "text",
"development_areas": "text",
"manager_comments": "text",
"employee_comments": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/hrms/performance-reviews/{id}Delete a performance reviews
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-reviews/{id}/calendar-inviteCalendar invite
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-reviews/{id}/calendar-invite/cancelCalendar invite cancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite/cancel" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-reviews/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/hrms/performance-reviews/{id}/startStart
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-reviews/{id}/decideDecide
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
decision, commentResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"decision":"value","comment":"value"}'GET/api/hrms/performance-reviews/{id}/stepsSteps
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/performance-reviews/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a performance reviews, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
cycle_id | uuid | read, write | Cycle |
employee_id | uuid | read, write | Employee |
reviewer_id | uuid | read, write | Reviewer |
overall_rating | text | read, write | Overall rating |
rating_value | numeric | read, write | Rating value |
potential_rating | text | read, write | Potential rating |
self_rating | text | read, write | Self rating |
calibrated_rating | text | read, write | Calibrated rating |
calibrated_by | uuid | read, write | Calibrated by |
strengths | text | read, write | Strengths |
development_areas | text | read, write | Development areas |
manager_comments | text | read, write | Manager comments |
employee_comments | text | read, write | Employee comments |
triggers_pip | boolean | read, write | Triggers a performance plan |
merit_eligible | boolean | read, write | Merit eligible |
promotion_recommended | boolean | read, write | Promotion recommended |
status | text | read, write | Status Allowed: draft self_review manager_review calibration approval shared acknowledged closed |
submitted_at | timestamp with time zone | read, write | Submitted at |
acknowledged_at | timestamp with time zone | read, write | Acknowledged at |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
workflow_id | uuid | read only | Workflow id |
step_seq | integer | read only | Step seq |
step_due_on | date | read only | Step due on |
step_actor | text | read only | Step actor |
step_role_code | text | read only | Step role code |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
last_reminded_on | date | read only | Last reminded on |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Performance Reviews for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.