Skip to navigation

/search/template/{template_uuid}

View as Markdown

Alias of

/template/{template_uuid}

/master/{template_uuid}

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

ParameterTypeRequiredDescription
template_uuidstringYesThe 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/<dataset_uuid>

Example Response (200 OK)

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

FieldTypeDescription
internal_idintegerInternal numeric ID of the template
namestringHuman-readable name of the template
descriptionstringnull
template_uuidstringCanonical UUID of the template
updated_atstringTimestamp of the last update (UTC)
metadata_for_uuidstringUUID of a linked metadata record, if any
render_pluginsarrayList of render plugins applied to this template
_database_metadataobjectAudit metadata (creation date/author, publish date, revision info)
fieldsarrayList of field definitions belonging to this template

Field Object (fields[])

FieldTypeDescription
internal_idintegerInternal numeric ID of the field
namestringHuman-readable field name
descriptionstringnull
fieldtypestringData type of the field (e.g. Short Text, Paragraph Text, Long Text, Integer, Boolean, Image, Single Select)
field_uuidstringUUID of this specific field instance
template_field_uuidstringnull
updated_atstringTimestamp of the last update (UTC)
is_uniqueinteger1 if values must be unique across records; omitted otherwise
render_pluginsarrayRender plugins applied to this field (omitted if none)
radio_optionsarrayAvailable options for Single Select fields (omitted for other field types)
_field_metadataobjectAudit metadata for the field

Radio Option Object (fields[].radio_options[])

FieldTypeDescription
namestringDisplay label for the option
template_radio_option_uuidstringUUID of the radio option
updated_atstringTimestamp of the last update (UTC)

Query Parameters

ParameterTypeRequiredDescription
XDEBUG_SESSION_STARTstringNoDebug parameter for PhpStorm Xdebug integration. Disabled by default.

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
Access-Control-Allow-HeadersstringOptional
Access-Control-Expose-HeadersstringOptional
Access-Control-Max-AgestringOptional
Cache-ControlstringOptional
Keep-AlivestringOptional

Response

OK
internal_idinteger
namestring
descriptionstring
template_uuidstring
updated_atstring
metadata_for_uuidstring
_database_metadataobject
fieldslist of objects
related_databaseslist of objects