List rules
List the governance rules in a workspace.
A rule is a single requirement Openlayer tracks. platform rules are evaluated automatically from
the state of your workspace; evidence rules are satisfied by attaching evidence. A rule can
belong to several frameworks at once, and rules that belong to none are returned too unless you
pass includeUnframed=false.
Pass includeResults=true to get each rule’s compliance results inline instead of fetching them
separately.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.
Path Parameters
The workspace id.
Query Parameters
The page to return in a paginated query.
x >= 1Maximum number of items to return per page.
1 <= x <= 100Only include items belonging to this framework.
Only include items that apply to this project.
Only include items belonging to at least one enabled framework.
Whether to include rules that are not part of any framework.
Whether to include each rule's results inline, in a results array.
Filter by a free-text search over names and descriptions.
Whether to sort in ascending order.
The field to sort on.
name, status, frameworks, scope, dateCreated Only include rules carrying all of these rule tags. Pass tag ids, which you can look up with List rule tags.
Only include rules that are deactivated (or active).
Only include rules assigned to this user.
Only include rules in one bucket of the compliance workflow. open covers rules that still need attention, done covers rules that are fully satisfied, and excluded covers rules that have been deactivated.
open, excluded, done Response
Status OK.