Change a rubric or marking guide that has not marked any work

Fields absent from the body are left as they are.

Quire permissions

Required capability: grade/managegradingforms.

Credential scopes: grades:write.

The acting subject must also be allowed to perform this action in the organisation.

PATCH

https://your-organisation.quirelms.com/api/v1/rubrics/{id}

View as Markdown

Authorisation

apiKeyoptionalHTTP
oauth2optionalOAuth 2.0

Path parameters

idstringrequired

Header parameters

Quire-Versionoptionalstring
The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.

format: date
Idempotency-Keyoptionalstring
A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with Idempotency-Replayed: true. Reusing a key for a different request is refused.

maxLength: 255

Request bodyJSONrequired

nameoptionalstring
maxLength: 255, minLength: 1
descriptionoptionalstringornull
2 variants
One of the following:
string
null
optionsoptionalmap ofboolean
Display options: showPointsToLearners, showRemarksToLearners, levelsAscending (rubric), showMaxToLearners (guide).
criteriaoptionalarray ofobject
Replaces every criterion and level. Refused once the form has marked work; copy it instead.
5 properties
- short_namestringrequired
  A rubric: the criterion text. A guide: the criterion name.
  
  maxLength: 1000, minLength: 1
- descriptionoptionalstringornull
  A guide: what markers see.
  
  2 variants
  One of the following:
  string
  null
- learner_descriptionoptionalstringornull
  A guide: what learners see.
  
  2 variants
  One of the following:
  string
  null
- max_scoreoptionalnumberornull
  A guide only: the most the criterion can score.
  
  2 variants
  One of the following:
  number
  null
- levelsoptionalarray ofobject
  A rubric only: the levels, in order.
  
  2 properties
  scorenumberrequired
  maximum: 100000, minimum: -100000
  definitionstringrequired
  maxLength: 4000, minLength: 1
commentsoptionalarray ofstring
A guide's frequently used comments.

maxLength: 4000, minLength: 1

Returns

200

Success.

JSON

idstringrequired
external_idstring | nullrequired
course_idstringrequired
methodrubricorguiderequired
namestringrequired
descriptionstring | nullrequired
optionsunknownrequired
is_templatebooleanrequired
criteriaunknownrequired
deleted_atstringornullrequired
2 variants
One of the following:
string
null
created_atstringrequired
RFC 3339 timestamp in UTC.
updated_atstringrequired
RFC 3339 timestamp in UTC.

401

The credential is missing, malformed, expired or revoked.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

404

No such resource, or none this credential is permitted to know about.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

409

The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

422

The request was understood and its content is not valid. errors names each field.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

429

A rate limit or a concurrency cap was reached. Retry-After says when to try again.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

500

Something failed at our end. Quote request_id when reporting it.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

curl --request PATCH \ --url https://your-organisation.quirelms.com/api/v1/rubrics/string \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "description": "string", "options": { "property1": true, "property2": true }, "criteria": [ { "short_name": "string", "description": "string", "learner_description": "string", "max_score": 100000, "levels": [ { "score": -100000, "definition": "string" } ] } ], "comments": [ "string" ] } '

{ "id": "string", "external_id": "string", "course_id": "string", "method": "rubric", "name": "string", "description": "string", "options": null, "is_template": true, "criteria": null, "deleted_at": "string", "created_at": "string", "updated_at": "string" }

{ "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" }