Skip to navigation

Put Grade

Write one scorecard cell. A grade that changes is recorded in the grade changes, as on the dashboard. Only checkpoints the objective’s period has are accepted. A grade moves the key result’s score: a Final grade becomes it, and another grade does while it is newer than the latest check-in. Clearing one goes back to the rest. noScore: true is the scorecard’s Reset score: the cell is emptied, whatever the check-ins say, and drops out of the objective’s cell and the averages, but the key result’s score is left alone. Setting a score, or sending score: null, undoes it.

A key may write any key result’s. A signed-in session writes only where its person may in the app: on a key result that is theirs or one of their teams’, or on any of an objective they may edit (see updateObjective). Anybody else gets 403 forbidden.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

keyResultIdstringRequired
checkpointenumRequired

Where the scorecard reads a grade. A quarterly objective is read at MID (halfway through its quarter) and FINAL; an annual one at the end of Q1, Q2 and Q3, and FINAL at the end of the year.

Allowed values:

Request

This endpoint expects an object.
scoredouble or nullOptional
noScorebooleanOptional

true resets the score: the cell is emptied, whatever the check-ins say, until a grade is set. Not with a score.

notestring or nullOptional

Response

This endpoint returns an object.
keyResultIdstring
checkpointenum

Where the scorecard reads a grade. A quarterly objective is read at MID (halfway through its quarter) and FINAL; an annual one at the end of Q1, Q2 and Q3, and FINAL at the end of the year.

Allowed values:
noScoreboolean

The score was reset on the scorecard; no score, whatever the check-ins say, until a grade is set.

scoredoubleOptional

Absent when the cell holds only a comment, its grade coming from the check-ins, or when noScore.

notestringOptional
noteByIdstringOptional
noteAtdatetimeOptional
gradedByIdstringOptional
updatedAtdatetimeOptional
Absent for a cell that holds nothing.

Errors

403
Forbidden Error
404
Not Found Error
422
Validation Error
429
Too Many Requests Error