BIbindbee
Performance Reviews

Get Performance Review By Id

Changed on

Returns a Performance Review object with the given id.

get/api/hris/v1/performance-reviews/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

The employee this performance review is for.

reviewerstring nullable required

The employee who conducted this performance review. Null when type is EXTERNAL or unset.

typestring nullable required

The type of performance review. If the value is not one of the defined enum values, the original value passed through will be returned.

review_cycle_namestring nullable required

The name of the review cycle this performance review belongs to.

review_cycle_start_datestring nullable required

The day and time the review cycle started.

review_cycle_end_datestring nullable required

The day and time the review cycle ended.

commentstring nullable required

A free-text comment left on the performance review.

statusstring nullable required

The status of the performance review. If the value is not one of the defined enum values, the original value passed through will be returned.

ratingobject nullable required

The overall rating given on this performance review, combining both the scale definition and the answer. Shape depends on the embedded 'type' key: when 'type' is 'NUMERIC', the object also carries 'min', 'max', 'step', and 'value'; when 'type' is 'SINGLE_SELECT', the object carries 'options' (the allowed labels) and 'value' (the selected label).

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "employee": "01a0b3cd-35a5-71df-8636-c86117dbf734",
  "reviewer": "01a0b3cd-35a5-71df-8636-c86117dbf778",
  "type": "MANAGER",
  "review_cycle_name": "Year End Review",
  "review_cycle_start_date": "2020-11-08T00:00:00Z",
  "review_cycle_end_date": "2020-12-08T00:00:00Z",
  "comment": "Good Improvement",
  "status": "COMPLETED",
  "rating": {
    "options": [
      "VERY BAD",
      "BAD",
      "GOOD",
      "VERY GOOD",
      "EXCELLENT"
    ],
    "type": "SINGLE_SELECT",
    "value": "VERY GOOD"
  }
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the COMPLETED enum value from the response property for the response status

    • info

      removed the EXTERNAL enum value from the response property for the response status

    • info

      removed the IN_PROGRESS enum value from the response property for the response status

    • info

      removed the MANAGER enum value from the response property for the response status

    • info

      removed the PEER enum value from the response property for the response status

    • info

      removed the SELF enum value from the response property for the response status

  • 4695175eeff0Revision changes
    • info

      endpoint added