Skip to main content
POST
Dry-run a terminology rename

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new TenantTermRename resource

One tenant's rename of one platform concept (terminology design §4.2 / §4.3).

Holds the review state and the approved output. It never holds rendered text: setting_label on Tenant is materialised from the active (non-reverted) renames plus the manual layer. UI translation keys only. Revert keeps the row (revertedAt set) so the admin can see what was undone and re-apply later; the applier enforces one active row per (tenant, term) — a UNIQUE key cannot, because NULL revertedAt rows do not collide in MySQL.

uuid
string | null
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

termId
string
customForms
(string | null)[] | null
newForms
(string | null)[] | null
confirmedHits
(string | null)[] | null
excluded
(string | null)[] | null
approved
(string | null)[] | null
appliedAt
string<date-time> | null
appliedBy
string<iri-reference> | null
Example:

"/api/v1/users/1"

revertedAt
string<date-time> | null

Response

TenantTermRename resource created

One tenant's rename of one platform concept (terminology design §4.2 / §4.3).

Holds the review state and the approved output. It never holds rendered text: setting_label on Tenant is materialised from the active (non-reverted) renames plus the manual layer. UI translation keys only. Revert keeps the row (revertedAt set) so the admin can see what was undone and re-apply later; the applier enforces one active row per (tenant, term) — a UNIQUE key cannot, because NULL revertedAt rows do not collide in MySQL.

id
integer
read-only
uuid
string | null
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only
termId
string
customForms
(string | null)[] | null
newForms
(string | null)[] | null
confirmedHits
(string | null)[] | null
excluded
(string | null)[] | null
approved
(string | null)[] | null
appliedAt
string<date-time> | null
appliedBy
string<iri-reference> | null
Example:

"/api/v1/users/1"

revertedAt
string<date-time> | null
active
boolean
read-only
customTerm
boolean
read-only
locales
(string | null)[]
read-only