Coronavirus (Covid-19): Latest updates and information
Skip to main content Skip to navigation

Retrieve a file attachment's metadata

Returns a file attachment object if a valid identifier was provided. Note that only the metadata of files is returned, not their content.

Permission requirements

There are no permission requirements to view metadata for file attachments.

Information about API permissions

Definition

GET https://tabula.warwick.ac.uk/api/v1/attachments/:attachmentId

URL substitution variables

:attachmentId The unique identifier for the attachment

Example request

GET https://tabula.warwick.ac.uk/api/v1/attachments/2552f556-6210-4de7-bb8e-01a3180f609e

Response parameters

An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 200 OK and the following parameters:

success Boolean true
status The string "ok"
attachment A file attachment object representing the attachment

Example response

{
  "success": true,
  "status": "ok",
  "attachment": {
    "id": "d91cf0be-9770-4150-9288-848df72fb14a",
    "name": "My coursework.docx",
    "temporary": true,
    "hash": "b2dbde870b92a43d78dddf47d359e052d67c9378",
    "uploadedBy": "in-matmannion-tabula-api",
    "dateUploaded": "2015-11-06T14:23:59Z"
  }
}

Tabula API Methods