Documentation | Rubrics › Create Rubric

Rubrics

rubrics

Methods

Create Rubric ->

post/v5/rubrics

Create Rubric

Response fields

Request example

curl https://api.egp.scale.com/v5/rubrics \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "title": "x"
        }'

200Example

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "tags": [
    "string"
  ],
  "title": "title",
  "version": 0,
  "archived_at": "2019-12-27T18:11:19.117Z",
  "criteria": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "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"
}

List Rubrics -> CursorPage<

>

get/v5/rubrics

List Rubrics

Get Rubric ->

get/v5/rubrics/{rubric_id}

Get Rubric

Update Or Restore Rubric ->

patch/v5/rubrics/{rubric_id}

Update or Restore Rubric

Archive Rubric -> { id, deleted, object }

delete/v5/rubrics/{rubric_id}

Archive Rubric

Domain types

RestoreRequest = { restore }

RubricArchiveResponse = { id, deleted, object }

RubricResponse = { id, created_at, created_by, 7 more... }

Criteria

rubrics.criteria

Methods

Add Criterion To Rubric ->

RubricCriteriaResponse

post/v5/rubrics/{rubric_id}/criteria

Add Criterion to Rubric

Update Criterion ->

RubricCriteriaResponse

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

Update Criterion

List Criterion Versions -> { has_more, items, total, 2 more... }

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

List Criterion Versions

Domain types

CriterionListVersionsResponse = { has_more, items, total, 2 more... }

RubricCriteriaInput = { title, annotations, weight }

RubricCriteriaResponse = { id, created_at, rubric_id, 5 more... }

RubricCriteriaSummaryResponse = { title, weight }

Slim criteria projection for list endpoints (title + weight only).