Documentation | Rubrics

Rubrics

RubricsResource

Methods

client.rubrics.create() ->

RubricResponse

post/v5/rubrics

Create Rubric

client.rubrics.list() -> SyncCursorPage[

RubricResponse

]

get/v5/rubrics

List Rubrics

client.rubrics.retrieve() ->

RubricResponse

get/v5/rubrics/{rubric_id}

Get Rubric

client.rubrics.update(, ) ->

RubricResponse

patch/v5/rubrics/{rubric_id}

Update or Restore Rubric

Parameters

rubric_id: str

rubric:

Rubric

class RubricPartialRubricRequestBase: ...

RestoreRequestParam

Returns

RubricResponse

id: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

tags: List[str]

The tags associated with the entity

title: str

version: int

archived_at: Optional[datetime]

(format: date-time)

criteria: Optional[List[

Criterion

]]

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

object: Optional[Literal["rubric"]]

(default: "rubric")

updated_at: Optional[datetime]

(format: date-time)

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
rubric_response = client.rubrics.update(
    rubric_id="rubric_id",
    rubric={},
)
print(rubric_response.id)

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