Documentation | Rubrics

Rubrics

rubrics

Methods

Create Rubric -> { created_at, created_by, rubric_id, 7 more... }

post/v5/rubrics

Create Rubric

List Rubrics -> CursorPage<{ created_at, created_by, rubric_id, 7 more... }>

get/v5/rubrics

List Rubrics

Get Rubric -> { created_at, created_by, rubric_id, 7 more... }

get/v5/rubrics/{rubric_id}

Get Rubric

path Parameters

rubric_id: string

Response fields

created_at: string

(format: date-time)

created_by:

Identity

The identity that created the entity.

rubric_id: string

tags: Array<string>

The tags associated with the entity

title: string

version: number

archived_at: string

Optional

(format: date-time)

criteria: Array<{ created_at, rubric_criteria_id, rubric_id, 5 more... } | { title, weight }>

Optional

Full criteria on get, summary (title + weight) on list

object: "rubric"

Optional

(default: "rubric")

updated_at: string

Optional

(format: date-time)

Request example

curl https://api.egp.scale.com/v5/rubrics/$RUBRIC_ID \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "rubric_id": "rubric_id",
  "tags": [
    "string"
  ],
  "title": "title",
  "version": 0,
  "archived_at": "2019-12-27T18:11:19.117Z",
  "criteria": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "rubric_criteria_id": "rubric_criteria_id",
      "rubric_id": "rubric_id",
      "title": "title",
      "version": 0,
      "annotations": {
        "foo": "bar"
      },
      "object": "rubric_criteria",
      "weight": 0
    }
  ],
  "object": "rubric",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Update Or Restore Rubric -> { created_at, created_by, rubric_id, 7 more... }

patch/v5/rubrics/{rubric_id}

Update or Restore Rubric

Archive Rubric -> { id, deleted, object }

delete/v5/rubrics/{rubric_id}

Archive Rubric

Domain types

RubricCreateResponse = { created_at, created_by, rubric_id, 7 more... }

RubricDeleteResponse = { id, deleted, object }

RubricListResponse = { created_at, created_by, rubric_id, 7 more... }

RubricRetrieveResponse = { created_at, created_by, rubric_id, 7 more... }

RubricUpdateResponse = { created_at, created_by, rubric_id, 7 more... }

Rubrics

Criteria

rubrics.criteria

Methods

Add Criterion To Rubric -> { created_at, rubric_criteria_id, rubric_id, 5 more... }

post/v5/rubrics/{rubric_id}/criteria

Add Criterion to Rubric

Update Criterion -> { created_at, rubric_criteria_id, rubric_id, 5 more... }

patch/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}

Update Criterion

List Criterion Versions -> Array<{ created_at, rubric_criteria_id, rubric_id, 5 more... }>

get/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions

List Criterion Versions

Domain types

CriterionCreateResponse = { created_at, rubric_criteria_id, rubric_id, 5 more... }

CriterionListVersionsResponse = Array<{ created_at, rubric_criteria_id, rubric_id, 5 more... }>

CriterionUpdateResponse = { created_at, rubric_criteria_id, rubric_id, 5 more... }