API

Get a schema for a rule format

get
https://{hostname}/papi/v1/schemas/products//

Get the JSON schema for the given product and rule format, which you can use to validate a rule tree object. Note that your rule tree may still fail to activate if you specify features that are optional within the schema for a product but not currently supported on your contract. To validate the set of currently available features you want to activate, run List available behaviors and List available criteria.

Path Params
string
required

Unique identifier for the product. See ID prefixes for details on omitting the value's prd_ prefix.

string
required

Name of the rule format. The rule format can be frozen to a specific version, or represent the latest set of behaviors and criteria.

Query Params
string

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
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago