Get framework by ID
Get a framework by ID.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Whether to include lifecycle status. Defaults to true.
Whether to include the flat requirements list. Defaults to false.
Used with includeRequirements. MY_PROGRAM (default) returns requirements as mapped in your program; CATALOG returns the framework's published requirements. Custom frameworks always use MY_PROGRAM. Both require the framework to be in your program.
MY_PROGRAM, CATALOG Catalog variant IDs to resolve CATALOG requirements against. Defaults to the framework's published defaults. Ignored for MY_PROGRAM, which uses your program's variants.
Response
Ok
The framework's unique ID.
The framework's display name.
The short version of the framework's display name.
The framework's description.
The number of completed controls in the framework.
The total number of controls in the framework.
The number of passing documents in the framework.
The total number of documents in the framework.
The number of passing tests in the framework.
The total number of tests in the framework.
The famework's list of requirement categories.
The framework's lifecycle status. Null means it has no lifecycle status. Omitted when includeStatus is false or status information is unavailable.
ACTIVE, DRAFT, SNOOZED, ARCHIVED, NEW_UPGRADE, null The assessment tiers your program is on, such as HITRUST i1. Omitted for frameworks without tiers.
The framework's requirements as a flat list that preserves their hierarchy. Omitted when requirements are unavailable.