Get an include's rule tree

get

https://{hostname}/papi/v1/includes/{includeId}/versions/{includeVersion}/rules

Limited availability Gets the entire rule tree for an include version. See the Rule Trees section for details on the response object's structure. Also use this operation to update from one rule format to another more recent version, incrementing the assigned set of features. See Update rules to a newer set of features.

Path Params

includeId

string

required

Unique identifier for the include. See ID prefixes for details on omitting the value's inc_ prefix.

includeVersion

integer

required

Include's incremental version number.

Query Params

contractId

string

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.

groupId

string

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.

validateRules

boolean

Defaults to true

Set to true by default. When false, skips validation tests that would identify potential problems within the response object's errors and warnings arrays. See Rule tree errors and warnings and Validation errors for information on how validation data appears in the response object. See Validation best practices for guidance on when to defer validation.

validateMode

string

enum

Defaults to full

Enum With validateRules enabled, setting this to fast performs a quick validation check based on the provided JSON. This is faster than the default full validation, which performs more extensive checks on the converted XML metadata configuration. See Validation best practices for more guidance.

Allowed:

originalInput

boolean

Defaults to true

When true, PAPI outputs a property's rule tree in the original form provided by the PUT operation, deliberately suppressing any updates. When set to true, PAPI still upgrades catalog features in the background each time you run GET and PATCH operations on property version rules, but the response yields the rule tree just as you last saved it. The parameter defaults to true.

accountSwitchKey

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

PAPI-Use-Prefixes

string

enum

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

200The response shows the rule tree for the requested include version.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.