> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.odr.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.odr.io/_mcp/server. # /dataset/quota/{dataset_uuid} GET https://dataset/quota/063c0d3d4bd183ab0dda87c544ae Retrieves the full template (datatype) definition for a given UUID. The UUID can be either a **template UUID** or a **dataset UUID** — the API accepts both interchangeably. Returns the template's name, description, field definitions (including field types, render plugins, and radio options where applicable), render plugins, and database metadata. ## Authentication A pre-request script automatically fetches a bearer token before each request: 1. POSTs to `{{url}}/token` with `{{apiuser}}` and `{{apipass}}` credentials 2. Stores the returned token in `{{token}}` 3. The token is then used as the `Authorization` header for the request ## Path Parameters | Parameter | Type | Required | Description | | --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | `template_uuid` | string | Yes | The UUID of the template (datatype) **or** the UUID of a dataset that uses that template. Both forms are accepted. | ## Example Requests ``` GET {{url}}/template/ddc5e9ba834ad596cc31aebb1225 ``` Using a dataset UUID in place of the template UUID: ``` GET {{url}}/template/ ``` ## Example Response (200 OK) ```json { "internal_id": 738, "name": "RRUFF Samples", "description": null, "template_uuid": "ddc5e9ba834ad596cc31aebb1225", "updated_at": "2026-01-08 18:47:44", "metadata_for_uuid": "", "render_plugins": [ { "render_plugin": "RRUFF Special Reference Plugin" }, { "render_plugin": "RRUFF Sample Plugin" }, { "render_plugin": "Linked Descendant Merger Plugin" }, { "render_plugin": "File Updater Helper Plugin" }, { "render_plugin": "RRUFF Sample Links Plugin" } ], "_database_metadata": { "_create_date": "2024-02-13 21:31:54", "_create_auth": "Alex Pires", "_public_date": "2024-02-13 21:32:00", "_master_published_version": "0", "_master_revision": "0", "_tracking_master_version": "0" }, "fields": [ { "internal_id": 7077, "name": "Sample Images", "description": null, "fieldtype": "Image", "field_uuid": "35a91c0ddd6a5ccf7681be7e9e4d", "template_field_uuid": "b571f4738325b415195f432f9625", "updated_at": "2025-01-14 18:59:25", "render_plugins": [{ "render_plugin": "File Renamer Addon" }], "_field_metadata": { "...": "..." } }, { "internal_id": 7069, "name": "RRUFF ID", "description": "Sample IDs must be unique within your collection.", "fieldtype": "Short Text", "field_uuid": "ee88404d73886150b59dd07cbb12", "template_field_uuid": "d0e7a8e1e42d8159008116130e86", "is_unique": 1, "updated_at": "2026-02-10 22:03:48", "_field_metadata": { "...": "..." } }, { "internal_id": 7070, "name": "Sample Status", "description": null, "fieldtype": "Single Select", "field_uuid": "e4bd3c7024d12f5c80da99fffd63", "radio_options": [ { "name": "The identification of this mineral has been confirmed by single-crystal X-ray diffraction", "template_radio_option_uuid": "92456147cc47c8de892767367ff1" }, { "name": "Unconfirmed", "template_radio_option_uuid": "2100da4a951510a9a455764d8404" } ], "_field_metadata": { "...": "..." } } ] } ``` ## Response Fields ### Top-level | Field | Type | Description | | | -------------------- | ------- | ------------------------------------------------------------------ | ------------------------------------ | | `internal_id` | integer | Internal numeric ID of the template | | | `name` | string | Human-readable name of the template | | | `description` | string | null | Optional description of the template | | `template_uuid` | string | Canonical UUID of the template | | | `updated_at` | string | Timestamp of the last update (UTC) | | | `metadata_for_uuid` | string | UUID of a linked metadata record, if any | | | `render_plugins` | array | List of render plugins applied to this template | | | `_database_metadata` | object | Audit metadata (creation date/author, publish date, revision info) | | | `fields` | array | List of field definitions belonging to this template | | ### Field Object (`fields[]`) | Field | Type | Description | | | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | `internal_id` | integer | Internal numeric ID of the field | | | `name` | string | Human-readable field name | | | `description` | string | null | Optional field description | | `fieldtype` | string | Data type of the field (e.g. `Short Text`, `Paragraph Text`, `Long Text`, `Integer`, `Boolean`, `Image`, `Single Select`) | | | `field_uuid` | string | UUID of this specific field instance | | | `template_field_uuid` | string | null | UUID of the parent template field this was derived from, if any | | `updated_at` | string | Timestamp of the last update (UTC) | | | `is_unique` | integer | `1` if values must be unique across records; omitted otherwise | | | `render_plugins` | array | Render plugins applied to this field (omitted if none) | | | `radio_options` | array | Available options for `Single Select` fields (omitted for other field types) | | | `_field_metadata` | object | Audit metadata for the field | | ### Radio Option Object (`fields[].radio_options[]`) | Field | Type | Description | | ---------------------------- | ------ | ---------------------------------- | | `name` | string | Display label for the option | | `template_radio_option_uuid` | string | UUID of the radio option | | `updated_at` | string | Timestamp of the last update (UTC) | ## Query Parameters | Parameter | Type | Required | Description | | ---------------------- | ------ | -------- | --------------------------------------------------------------------- | | `XDEBUG_SESSION_START` | string | No | Debug parameter for PhpStorm Xdebug integration. Disabled by default. | Reference: https://docs.odr.io/odr-search-api-v-4/dataset-quota-dataset-uuid ## Response ### 200 OK - `total_bytes` (string, required) ## Examples **Response** ```json { "total_bytes": "25023228241" } ``` **SDK Code** ```python /dataset/quota/{dataset_uuid}_example import requests url = "https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae" response = requests.get(url) print(response.json()) ``` ```javascript /dataset/quota/{dataset_uuid}_example const url = 'https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae'; const options = {method: 'GET'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go /dataset/quota/{dataset_uuid}_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby /dataset/quota/{dataset_uuid}_example require 'uri' require 'net/http' url = URI("https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```java /dataset/quota/{dataset_uuid}_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae") .asString(); ``` ```php /dataset/quota/{dataset_uuid}_example request('GET', 'https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae'); echo $response->getBody(); ``` ```csharp /dataset/quota/{dataset_uuid}_example using RestSharp; var client = new RestClient("https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift /dataset/quota/{dataset_uuid}_example import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://https/dataset/quota/063c0d3d4bd183ab0dda87c544ae")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```