Include version rules

Number of APIs: 4

1. Get an include's rule tree

GET https://{{host}}/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.

---

2. Update an include's rule tree

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

Limited availability To write a rule tree to an include version, make a PUT request to the same resource as the GET request that reads it, passing in the rule object in the body of the request. See the Rule Trees section for details on the rule tree's structure. 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. 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. See Rule tree errors and warnings and Validation errors for information on how validation data is embedded within the response object.

---

3. Patch an include's rule tree

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

Limited availability Selectively modify a rule tree using JSON patch syntax. 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. 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 an include's rule tree

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

Limited availability 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.

---