Skip to content

UpdateFeatureCatalog

PUT
/api/v1/provision/admin/feature-catalog/{id}
curl --request PUT \
--url https://example.com/api/v1/provision/admin/feature-catalog/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "units": "example", "metricName": "example", "featureType": "Boolean", "visibility": "Public", "meterAggregationType": "CumulativeCounter", "valueScore": 1, "enumOptions": [ { "value": "example", "description": "example" } ], "tags": [ "example" ] }'
id
required
string format: uuid

Admin update payload for a feature catalog entry; the feature code and lifecycle status are managed separately.

object
name
string
units
null | string
metricName
null | string
featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField
visibility

Who can see a feature.

Allowed values: Public Internal
meterAggregationType
One of:
null
valueScore

Relative, unitless value weight used by value-delivered analytics; null means the feature is not valued yet.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
enumOptions
Array<object>

One allowed value of an Enumeration-typed feature.

object
value
string
description
null | string
tags

Replacement set of tag names from the TagScopeDto.FeatureCatalog vocabulary. Null leaves the current tags unchanged; an empty list clears them; a list replaces the set wholesale. Names not yet in the registry are created there.

Array<string> | null

OK

A feature definition in a product’s feature catalog: the canonical source for a feature code’s type, allowed values, metering, and visibility. Whether end users are asked to rate a feature is configured separately, per campaign — see RatingCampaignDto.

object
id
string format: uuid
productId
string format: uuid
featureCode
string
name
string
units
null | string
metricName

Metric name a Metered feature reports usage under.

null | string
featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField
lifecycleStatus

Lifecycle state of a feature catalog entry.

Allowed values: Draft Preview Published Disabled Archived
visibility

Who can see a feature.

Allowed values: Public Internal
meterAggregationType
One of:
null
valueScore

Relative, unitless value weight used by value-delivered analytics. Null means the feature is not valued yet and contributes nothing. Weights are applied when a report is generated, so changing one re-values history — intended behaviour for a relative measure.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
enumOptions
Array<object>

One allowed value of an Enumeration-typed feature.

object
value
string
description
null | string
tags

Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.

Array<string>
isDeleted
boolean
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
null | string format: date-time
revisionNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/