Property version rules

Number of APIs: 4

1. Get a property's rule tree

GET https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion/rules

Gets the entire rule tree for a property version. See the Rule Trees section for details on the response object's structure.

Also use this operation to: - Update from one frozen rule format to a more recent version, incrementing the assigned set of features. See Update rules to a newer set of features. - Update a set of features to their most recent version in the latest rule format. You may experience some stability problems when new versions of features emerge with new requirements. You should use the most recent dated rule format available. See API versioning for details.

If the response includes any validation errors, you need to resolve them before activating the property version.

---

2. Update a property's rule tree

PUT https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion/rules

To write a rule tree to a property version, make a PUT request to the same resource as the GET request that reads it. Pass in the rule object in the body of the request. See the Rule Trees section for details on the rule tree's structure. Set the validateRules query parameter to false to bypass a set of validation tests that may significantly slow this operation's execution time. See Validation best practices for guidance on when to defer validation. If the GET response yields any rule tree errors, you need to fix them before activating. This PUT operation saves a rule tree even if it contains errors that block the property activation. See Rule tree errors and warnings and Validation errors for information on how validation data is embedded within the response object.

Use this operation also to Freeze a set of rules to a rule format version to ensure no change in a deployed activation's behavior.

---

3. Patch a property's rule tree

PATCH https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion/rules

Selectively modify a rule tree using JSON patch syntax. As a component of the larger Bulk patch a set of properties, this operation patches an individual rule tree. See Bulk Search and Update for more information. To bypass a set of validation tests that may significantly slow this operation's execution time, set the validateRules query parameter to false or validateMode to fast. See Validation best practices for guidance on when to defer validation. See Rule tree errors and warnings and Validation errors for information on how validation data is embedded within the response object.

---

4. Get a digest for a property's rule tree

HEAD https://{{host}}/papi/v1/properties/:propertyId/versions/:propertyVersion/rules

Gets the rule tree's ETag without the rule tree object. Ordinarily when you get a rule tree, the response includes a large rule tree object. As discussed in Concurrency control, it includes a top-level etag data digest to use when writing back the data. Use this operation if you simply want to get the ETag as a header without the data.

---