Upload a file for a submission, a post or a quiz answer

The upload session API, as the calling person. With content_base64 the file is stored and scanned at once and its file_id returned. Without it a session is opened: PUT the bytes to put.url, then complete the session; the address goes straight to object storage where the deployment uses it.

Quire permissions

Credential scopes: me:write.

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

POST

https://your-organisation.quirelms.com/api/v1/me/uploads

View as Markdown

Authorisation

apiKeyoptionalHTTP
oauth2optionalOAuth 2.0

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

course_idstringrequired
format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
purposeassignment_submissionorforum_postorquiz_responserequired
What the file is for, which decides who may upload it.
activity_idstringrequired
The assignment, forum or quiz activity.

format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
namestringrequired
maxLength: 255, minLength: 1
mime_typestringrequired
maxLength: 255, minLength: 3
sizeintegerrequired
The size in bytes.

maximum: 9007199254740991, minimum: 0
attempt_idoptionalstring
For a quiz response: the attempt.

format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
slot_numberoptionalinteger
For a quiz response: the question slot.

maximum: 32767, minimum: 1
content_base64optionalstring
The file itself, for a file under about 3 MB. Larger files leave this out, PUT the bytes to the returned address and complete the session.

maxLength: 4000000

Returns

201

Success.

JSON

session_idstring | nullrequired
statependingorcommittedrequired
file_idstring | nullrequired
namestringrequired
mime_typestringrequired
sizeintegerrequired
maximum: 9007199254740991, minimum: -9007199254740991
expires_atstring | nullrequired
putobjectornullrequired
2 variants
One of the following:
object
null
multipart_upload_idstring | nullrequired
part_countintegerornullrequired
2 variants
One of the following:
integer
null

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

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 POST \ --url https://your-organisation.quirelms.com/api/v1/me/uploads \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347", "purpose": "assignment_submission", "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f", "attempt_id": "7a838dca-3ea8-4a7c-8133-ba2c86aeb22d", "slot_number": 1, "name": "string", "mime_type": "string", "size": 9007199254740991, "content_base64": "string" } '

{ "session_id": "string", "state": "pending", "file_id": "string", "name": "string", "mime_type": "string", "size": -9007199254740991, "expires_at": "string", "put": { "url": "string", "method": "string", "headers": { "property1": "string", "property2": "string" } }, "multipart_upload_id": "string", "part_count": -9007199254740991 }

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