LookupTypes
Controlled lists of allowed values, with versioning and publication.
Create a lookup type
Defines a controlled list of codes — countries, currencies, risk tiers. Attributes bound to a lookup accept only its codes, which is what stops the same concept arriving spelled five ways. Requires `rdm.lookup-type.create`.
List lookup types
Returns the tenant's lookup types with their value counts and lifecycle state. Requires `rdm.lookup-type.read`.
Get a lookup type by name
Returns the published version of a lookup type by its name, which is stable across versions. Prefer this over the id when integrating, so a new version does not break the caller. Requires `rdm.lookup-type.read`.
List a lookup type's versions
Returns every version of a named lookup type, so you can see what changed and when. Requires `rdm.lookup-type.read`.
Get a lookup type
Returns one lookup type with its version and publication state. Its values are a separate call. Returns 404 if it does not exist, has been deleted, or belongs to another tenant. Requires `rdm.lookup-type.read`.
Update a lookup type
Changes a lookup type's own fields. Its values are managed through the values collection. Requires `rdm.lookup-type.update`.
Delete a lookup type
Soft-deletes a lookup type. A type still referenced by an attribute cannot be deleted. Requires `rdm.lookup-type.delete`.
List where a lookup type is used
Returns the attributes bound to this lookup. Read it before retiring a value — this is what would be affected. Requires `rdm.lookup-type.read`.
Restore a deleted lookup type
Reinstates a soft-deleted lookup type with its values. Requires `rdm.lookup-type.update`.
Publish a lookup type
Makes this version the one that name-based lookups resolve to. Publish once the values are settled, so integrations move deliberately rather than on every edit. Requires `rdm.lookup-type.create`.
Unpublish a lookup type
Withdraws this version from name-based resolution, leaving it editable again. Requires `rdm.lookup-type.create`.
Clone a lookup type into a new version
Copies a lookup type and its values into a new version, so a change can be prepared and reviewed without disturbing what integrations are currently resolving. Requires `rdm.lookup-type.create`.