Documentation | Rubrics › List Rubrics

Rubrics

rubrics

Methods

Create Rubric ->

RubricResponse

post/v5/rubrics

Create Rubric

List Rubrics -> CursorPage<

RubricResponse

get/v5/rubrics

List Rubrics

query Parameters

ending_before: string

Optional

limit: number

Optional

(maximum: 10000, minimum: 1, default: 100)

sort_by: string

Optional

sort_order:

SortOrder

Optional

starting_after: string

Optional

tags: Array<string>

Optional

Filter by tags

title: string

Optional

Filter by title (case-insensitive)

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

RubricResponse

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

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

200Example

{
  "has_more": true,
  "items": [
    {
      "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"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Get Rubric ->

RubricResponse

get/v5/rubrics/{rubric_id}

Get Rubric

Update Or Restore Rubric ->

RubricResponse

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... }

Rubrics

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).