Qodex.ai

List available criteria for a property

GET https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion/available-criteria

Lists the set of criteria you may apply within a property version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(Optional) Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix.
groupIdstring(Optional) Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Acceptstring

RESPONSES

status: OK

{"contractId":"ctr_K-0N7RAK7","criteria":{"items":[{"name":"fileExtension","schemaLink":"/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/criteria/fileExtension"},{"name":"hostname","schemaLink":"/papi/v0/schemas/products/prd_Alta/latest#/definitions/catalog/criteria/hostname"}]},"groupId":"grp_54321","productId":"prd_Alta","ruleFormat":"v2022-10-18"}