TRANXACT.AI Help

HRMS · Performance & Talent

Performance Reviews

Performance and potential are different axes, and conflating them is what makes a nine-box impossible to build later.

Type REST11 operationsBase path /api/hrms/performance-reviewsPublished as /api/v1/performance-reviews

Download specification (OpenAPI 3.1) Screen: Performance Reviews

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.performance_reviews · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
cycle_iduuidYesCycle
employee_iduuidYesEmployee
reviewer_iduuidNoReviewer
overall_ratingtextNoOverall rating
rating_valuenumericNoRating value
potential_ratingtextNoPotential rating
self_ratingtextNoSelf rating
calibrated_ratingtextNoCalibrated rating
calibrated_byuuidNoCalibrated by
strengthstextNoStrengths
development_areastextNoDevelopment areas
manager_commentstextNoManager comments
employee_commentstextNoEmployee comments
triggers_pipbooleanNoTriggers a performance plan
merit_eligiblebooleanNoMerit eligible
promotion_recommendedbooleanNoPromotion recommended
statustextNoStatus
Allowed: draft self_review manager_review calibration approval shared acknowledged closed
submitted_attimestamp with time zoneNoSubmitted at
acknowledged_attimestamp with time zoneNoAcknowledged 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
cycle_iduuidYesCycle
employee_iduuidYesEmployee
reviewer_iduuidNoReviewer
overall_ratingtextNoOverall rating
rating_valuenumericNoRating value
potential_ratingtextNoPotential rating
self_ratingtextNoSelf rating
calibrated_ratingtextNoCalibrated rating
calibrated_byuuidNoCalibrated by
strengthstextNoStrengths
development_areastextNoDevelopment areas
manager_commentstextNoManager comments
employee_commentstextNoEmployee comments
triggers_pipbooleanNoTriggers a performance plan
merit_eligiblebooleanNoMerit eligible
promotion_recommendedbooleanNoPromotion recommended
statustextNoStatus
Allowed: draft self_review manager_review calibration approval shared acknowledged closed
submitted_attimestamp with time zoneNoSubmitted at
acknowledged_attimestamp with time zoneNoAcknowledged 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, comment

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/decide" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"value","comment":"value"}'
GET/api/hrms/performance-reviews/{id}/stepsSteps

Path parameters

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
cycle_iduuidread, writeCycle
employee_iduuidread, writeEmployee
reviewer_iduuidread, writeReviewer
overall_ratingtextread, writeOverall rating
rating_valuenumericread, writeRating value
potential_ratingtextread, writePotential rating
self_ratingtextread, writeSelf rating
calibrated_ratingtextread, writeCalibrated rating
calibrated_byuuidread, writeCalibrated by
strengthstextread, writeStrengths
development_areastextread, writeDevelopment areas
manager_commentstextread, writeManager comments
employee_commentstextread, writeEmployee comments
triggers_pipbooleanread, writeTriggers a performance plan
merit_eligiblebooleanread, writeMerit eligible
promotion_recommendedbooleanread, writePromotion recommended
statustextread, writeStatus
Allowed: draft self_review manager_review calibration approval shared acknowledged closed
submitted_attimestamp with time zoneread, writeSubmitted at
acknowledged_attimestamp with time zoneread, writeAcknowledged at
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
workflow_iduuidread onlyWorkflow id
step_seqintegerread onlyStep seq
step_due_ondateread onlyStep due on
step_actortextread onlyStep actor
step_role_codetextread onlyStep role code
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
last_reminded_ondateread onlyLast reminded on

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Performance Reviews for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.