Get a rubric

client.Rubrics.Get(ctx, rubricID) (*RubricResponse, error)

GET/v5/rubrics/{rubric_id}

Retrieve a single rubric with the full detail of its current criteria.

Returns the latest version of the rubric along with all of its current (latest-version) criteria in full — not the slim title/weight summary returned by the list endpoint. Archived rubrics remain retrievable through this endpoint even though they are hidden from the list endpoint.

ParametersExpand Collapse

rubricID string

ReturnsExpand Collapse

type RubricResponse struct{…}

ID string

CreatedAt Time

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

Tags []string

The tags associated with the entity

Title string

Version int64

ArchivedAt TimeOptional

formatdate-time

Criteria []RubricResponseCriterionUnionOptional

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

One of the following:

type RubricCriteriaResponse struct{…}

ID string

CreatedAt Time

formatdate-time

RubricID string

Title string

Version int64

Annotations map[string, any]Optional

Object RubricCriteriaResponseObjectOptional

Weight float64Optional

type RubricCriteriaSummaryResponse struct{…}

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

Title string

Weight float64Optional

Object RubricResponseObjectOptional

UpdatedAt TimeOptional

formatdate-time

Get a rubric

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  rubricResponse, err := client.Rubrics.Get(context.TODO(), "rubric_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", rubricResponse.ID)
}

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

Returns Examples

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