Performance & reviews

Review cycles, templates, questions and sessions — run performance reviews programmatically.

Review Cycle

Endpoints

GET	/review-cycles	Retrieves the collection of ReviewCycle resources.
POST	/review-cycles	Creates a ReviewCycle resource.
GET	/review-cycles/{id}	Retrieves a ReviewCycle resource.
PATCH	/review-cycles/{id}	Updates the ReviewCycle resource.
DELETE	/review-cycles/{id}	Removes the ReviewCycle resource.
POST	/review-cycles/{id}/close	Creates a ReviewCycle resource.
POST	/review-cycles/{id}/launch	Creates a ReviewCycle resource.
POST	/review-cycles/{id}/release	Creates a ReviewCycle resource.

Schema fields

Field	Type	Description
id	string
name*	string
periodStart*	string (date-time)
periodEnd*	string (date-time)
status	string
launchedAt	string,null (date-time)
closedAt	string,null (date-time)
releasedAt	string,null (date-time)
template	string,null (iri-reference)
createdBy	string (iri-reference)
sessions	array
questions	array	Cycle-bespoke questions (when no template is attached).
createdAt	string (date-time)
updatedAt	string (date-time)
possibleStatuses	string

Review Template

Endpoints

GET	/review-templates	Retrieves the collection of ReviewTemplate resources.
POST	/review-templates	Creates a ReviewTemplate resource.
GET	/review-templates/{id}	Retrieves a ReviewTemplate resource.
PATCH	/review-templates/{id}	Updates the ReviewTemplate resource.
DELETE	/review-templates/{id}	Removes the ReviewTemplate resource.
POST	/review-templates/{id}/clear-default	Creates a ReviewTemplate resource.
POST	/review-templates/{id}/set-default	Creates a ReviewTemplate resource.

Schema fields

Field	Type	Description
id	string
name*	string
isDefault	boolean
questions	array
createdAt	string (date-time)
updatedAt	string (date-time)
default	boolean

Review Question

Endpoints

GET	/review-questions	Retrieves the collection of ReviewQuestion resources.
POST	/review-questions	Creates a ReviewQuestion resource.
GET	/review-questions/{id}	Retrieves a ReviewQuestion resource.
PATCH	/review-questions/{id}	Updates the ReviewQuestion resource.
DELETE	/review-questions/{id}	Removes the ReviewQuestion resource.

Schema fields

Field	Type	Description
id	string
template	string,null (iri-reference)
cycle	string,null (iri-reference)
position*	integer
prompt*	string
type	string
required	boolean
createdAt	string (date-time)
updatedAt	string (date-time)
possibleTypes	string

Review Session

Endpoints

GET	/review-sessions	Retrieves the collection of ReviewSession resources.
GET	/review-sessions/{id}	Retrieves a ReviewSession resource.
PATCH	/review-sessions/{id}	Updates the ReviewSession resource.
POST	/review-sessions/{id}/reassign	Creates a ReviewSession resource.
POST	/review-sessions/{id}/submit	Creates a ReviewSession resource.

Schema fields

Field	Type	Description
id	string
cycle	string (iri-reference)
reviewee	string (iri-reference)
reviewer	string (iri-reference)
reviewerKind	string
status	string
submittedAt	string,null (date-time)
answers	array	NOT in `review_session:write` — ApiPlatform's collection denormalization for OneToMany trips on the orphanRemoval + uniq_review_answer combo (remove-then-add at flush time conflicts with the unique constraint). The custom `ReviewSessionPatchProcessor` reads the answers array off the raw PATCH body and reconciles by `question` IRI — the only stable key when the input may or may not carry a real `@id`.

Review Target

Endpoints

GET	/review-targets	Retrieves the collection of ReviewTarget resources.
POST	/review-targets	Creates a ReviewTarget resource.
GET	/review-targets/{id}	Retrieves a ReviewTarget resource.
PATCH	/review-targets/{id}	Updates the ReviewTarget resource.
DELETE	/review-targets/{id}	Removes the ReviewTarget resource.

Schema fields

Field	Type	Description
id	string
cycle	string,null (iri-reference)
employee*	string (iri-reference)
title*	string
description	stringnull
kind	string
targetValue	stringnull
unit	stringnull
actualValue	stringnull
outcome	stringnull
reviewComment	stringnull
assessedAt	string,null (date-time)
position	integer
objective	string,null (iri-reference)
weight	stringnull
status	string
createdBy	string (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)
possibleKinds	string
possibleOutcomes	string

Review Answer

Endpoints

GET

/review-answers/{id}

Schema fields

Field	Type	Description
id	string
session	string (iri-reference)
question	string (iri-reference)
rating	stringnull
freeText	stringnull
lockVersion	integer
createdAt	string (date-time)
updatedAt	string (date-time)
possibleRatings	string