PATCH - Rubric Criteria

This API allows authenticated users to partially update an existing rubric criteria using its ID. Only the fields that need modification should be sent in the request body.

Key Notes:

This is a partial update, so all fields are optional.
Useful when you want to update just one or two properties like maxScore or scoringLogic.
Returns the updated rubric criteria along with its metadata.

Fields You Can Update:

name: Title of the criteria (e.g., Cohesiveness).
description: (Optional) More context or explanation of the criteria.
maxScore / minScore: Scoring range (e.g., 1 Star to 5 Star).
scoringLogic: Array of objects defining logic per score.

Scenario: Editing Scoring Logic

A teacher wants to improve clarity in the scoring explanation for a specific score value.

PATCH

rubrics

rubric

{id}

criteria

{criteriaId}

Update Rubric Criteria

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/rubrics/v1/rubric/{id}/criteria/{criteriaId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Cohesiveness",
  "description": "Optional detailed info about this criteria",
  "maxScore": "5 Star",
  "minScore": "1 Star",
  "scoringLogic": [
    {
      "score": "5 Star",
      "scoringLogic": "Logical & coherent sequence with a smooth beginning, a solid middle & an impactful conclusion"
    }
  ]
}
'

{
  "id": "d102b0ff-1111-4235-b8e9-764ef03c57cb",
  "name": "Cohesiveness",
  "maxScore": "5 Star",
  "minScore": "1 Star",
  "scoringLogic": [
    {
      "score": "5 Star",
      "scoringLogic": "Logical & coherent sequence with a smooth beginning, a solid middle & an impactful conclusion"
    }
  ],
  "createdAt": "2025-03-27T11:34:53.172550Z",
  "modifiedAt": "2025-03-27T11:35:17.739952Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

ID of the rubric the criteria belongs to

criteriaId

string

required

ID of the rubric criteria to be updated

Body

application/json

name

string

Name of the rubric criteria

Example:

"Cohesiveness"

description

string

Description of the rubric criteria

Example:

"Optional detailed info about this criteria"

maxScore

string

Maximum score for the criterion

Example:

"5 Star"

minScore

string

Minimum score for the criterion

Example:

"1 Star"

scoringLogic

object[]

Show child attributes

Response

Rubric criteria updated successfully.

string

Unique identifier for the rubric criteria

Example:

"d102b0ff-1111-4235-b8e9-764ef03c57cb"

name

string

Name of the rubric criteria

Example:

"Cohesiveness"

maxScore

string

Maximum score for the criterion

Example:

"5 Star"

minScore

string

Minimum score for the criterion

Example:

"1 Star"

scoringLogic

object[]

Show child attributes

createdAt

string<date-time>

Timestamp when the rubric criteria was created

Example:

"2025-03-27T11:34:53.172550Z"

modifiedAt

string<date-time>

Timestamp when the rubric criteria was last modified

Example:

"2025-03-27T11:35:17.739952Z"

GET - Boards This API allows authenticated users to retrieve all boards. **How to Use:** 1. Call `GET /metadata/v1/board` to get the list of all boards and their unique `id` values. 2. Use the `id` of the required board in lesson plans or any other feature that needs a board reference. **Example Scenario:** A teacher wants to create or view a lesson plan for a specific board: - First, they call this API to list all boards and find the required board's `id`. - Then, they use that `id` in the lesson plan API or anywhere else in the system where a board reference is needed.

Update Rubric Criteria

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/rubrics/v1/rubric/{id}/criteria/{criteriaId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Cohesiveness",
  "description": "Optional detailed info about this criteria",
  "maxScore": "5 Star",
  "minScore": "1 Star",
  "scoringLogic": [
    {
      "score": "5 Star",
      "scoringLogic": "Logical & coherent sequence with a smooth beginning, a solid middle & an impactful conclusion"
    }
  ]
}
'

{
  "id": "d102b0ff-1111-4235-b8e9-764ef03c57cb",
  "name": "Cohesiveness",
  "maxScore": "5 Star",
  "minScore": "1 Star",
  "scoringLogic": [
    {
      "score": "5 Star",
      "scoringLogic": "Logical & coherent sequence with a smooth beginning, a solid middle & an impactful conclusion"
    }
  ],
  "createdAt": "2025-03-27T11:34:53.172550Z",
  "modifiedAt": "2025-03-27T11:35:17.739952Z"
}

Documentation Index

Authorizations

Path Parameters

Body

Response