Retrieve a release rule
/products/{product_id}/access-schedules/{access_schedule_id}/rules/{release_rule_id}Retrieves the release rule of a single node. Release rule IDs have the format rul_<level>_<node>.
Nodes without their own rule also return a result, with explicit set to false and effective containing the inherited rule.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/products/string/access-schedules/string/rules/string"{ "data": { "effective": { "inherited_from": "string", "params": [], "type": "free" }, "explicit": true, "id": "string", "level": "product", "object": "release_rule", "params": null, "target_id": "string", "type": "free" }}Create a release rule POST
Creates the release rule for a node of the product tree that does not yet have its own rule. The node is identified by `level` (`product`, `section`, or `lesson`) and `target_id`; a `section` is identified by its module ID (`mod_`). If the node already has its own rule, the request returns the `already_exists` error code; use the update operation to change it instead. The `hidden` type is not accepted at the `product` level, and the `percentage` type is read-only and cannot be set.
Update a release rule PATCH
Updates the `type` and `params` of a node that already has its own release rule. Other nodes are never changed. The revision is tracked for the access schedule as a whole. Send the access schedule's current `ETag` value in the `If-Match` header to avoid overwriting a newer version.