Doc Ref
A Doc Ref (or Document Reference) is an identifier used to identify most documents/entities in Stroom, e.g. an XSLT will have a Doc Ref.
It is comprised of the following parts:
-
UUID
UUID
A Universally Unique Identifier for uniquely identifying something. UUIDs are used as the identifier in Doc Refs. An example of a UUID isClick to see more details... - A Universally Unique Identifier to uniquely identify the document/entity.
4ffeb895-53c9-40d6-bf33-3ef025401ad3. - Type - The type of the document/entity, e.g.
Index,XSLT,Dashboard, etc. - Name - The name given to the document/entity.
Doc Refs are used heavily in the REST API for identifying the document/entity to be acted on.
See Also
Document
Document
Typically refers to an item that can be created in the Explorer Tree, e.g. a Feed, a Pipeline, a Dashboard, etc. May also be known as an Entity.
Click to see more details…
Last modified October 20, 2026: Merge pull request #144 from gchq/add-7.14-rel-notes (2c6fb22)