Read a reference type
Reads one registered reference type: its scope keys, correlation, sensitivity, mask and whether it is searchable. Producers call it to check a type before declaring it in a contract.
Rules
- The name is the whole identity.
- An unregistered name answers
404, including a name that could never be registered: the read never tells whether a name is well-formed.
Responses
200the reference type.404SF-0091no reference type under this name.503SF-0094retry later.
Autorizações
JWT issued by the identity provider. A producer calls with a service credential issued for the tenant it sends facts for; a reader calls with a user token or a service credential. The tenant is always taken from the token, never from the request path, query or body.
Parâmetros de caminho
Name of the reference type to read.
"acme.order_id"
Resposta
The reference type as registered: its scope keys, correlation, sensitivity, mask and whether it is searchable.
Whether references of this type link facts into flows. Allowed values: exact, none.
exact, none When the type was registered. RFC 3339, UTC.
What the reference identifies, as registered.
Verified identity that registered the type, in the form owner/sub; recorded for audit only.
"acme/platform-deployer"
Scope keys that complete the reference identity, sorted.
Whether listFlowsByReference can list facts by this type.
Protection of values at rest and on reads; see Sensitivity and protected values. Allowed values: none, masked, hashed, encrypted.
none, masked, hashed, encrypted Reference type name.
"acme.order_id"
Display format of the type; omitted when it has none. Allowed values: document.
document 
