Performance & reviews

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

Această referință este generată din schema API. Descrierile câmpurilor și orice text încă netradus sunt afișate în engleză.

Review Cycle

Endpoints

Review Cycle: Endpoints
MethodPath
GET/review-cycles
POST/review-cycles
GET/review-cycles/{id}
PATCH/review-cycles/{id}
DELETE/review-cycles/{id}
POST/review-cycles/{id}/close
POST/review-cycles/{id}/launch
POST/review-cycles/{id}/release

Schema fields

Review Cycle: Schema fields
FieldType
idstring
name*string
periodStart*string (date-time)
periodEnd*string (date-time)
statusstring
launchedAtstring,null (date-time)
closedAtstring,null (date-time)
releasedAtstring,null (date-time)
templatestring,null (iri-reference)
createdBystring (iri-reference)
sessionsarray
questionsarray
createdAtstring (date-time)
updatedAtstring (date-time)
possibleStatusesstring

Review Template

Endpoints

Review Template: Endpoints
MethodPath
GET/review-templates
POST/review-templates
GET/review-templates/{id}
PATCH/review-templates/{id}
DELETE/review-templates/{id}
POST/review-templates/{id}/clear-default
POST/review-templates/{id}/set-default

Schema fields

Review Template: Schema fields
FieldType
idstring
name*string
isDefaultboolean
questionsarray
createdAtstring (date-time)
updatedAtstring (date-time)
defaultboolean

Review Question

Endpoints

Review Question: Endpoints
MethodPath
GET/review-questions
POST/review-questions
GET/review-questions/{id}
PATCH/review-questions/{id}
DELETE/review-questions/{id}

Schema fields

Review Question: Schema fields
FieldType
idstring
templatestring,null (iri-reference)
cyclestring,null (iri-reference)
position*integer
prompt*string
typestring
requiredboolean
createdAtstring (date-time)
updatedAtstring (date-time)
possibleTypesstring

Review Session

Endpoints

Review Session: Endpoints
MethodPath
GET/review-sessions
GET/review-sessions/{id}
PATCH/review-sessions/{id}
POST/review-sessions/{id}/reassign
POST/review-sessions/{id}/submit

Schema fields

Review Session: Schema fields
FieldType
idstring
cyclestring (iri-reference)
revieweestring (iri-reference)
reviewerstring (iri-reference)
reviewerKindstring
statusstring
submittedAtstring,null (date-time)
answersarray

Review Target

Endpoints

Review Target: Endpoints
MethodPath
GET/review-targets
POST/review-targets
GET/review-targets/{id}
PATCH/review-targets/{id}
DELETE/review-targets/{id}

Schema fields

Review Target: Schema fields
FieldType
idstring
cyclestring,null (iri-reference)
employee*string (iri-reference)
title*string
descriptionstringnull
kindstring
targetValuestringnull
unitstringnull
actualValuestringnull
outcomestringnull
reviewCommentstringnull
assessedAtstring,null (date-time)
positioninteger
objectivestring,null (iri-reference)
weightstringnull
statusstring
createdBystring (iri-reference)
createdAtstring (date-time)
updatedAtstring (date-time)
possibleKindsstring
possibleOutcomesstring

Review Answer

Endpoints

Review Answer: Endpoints
MethodPath
GET/review-answers/{id}

Schema fields

Review Answer: Schema fields
FieldType
idstring
sessionstring (iri-reference)
questionstring (iri-reference)
ratingstringnull
freeTextstringnull
lockVersioninteger
createdAtstring (date-time)
updatedAtstring (date-time)
possibleRatingsstring