Framework

This document describes the API for reading Frameworks.

List Frameworks

Returns a list of Frameworks.

Search parameters

Filter	Description
`created_at`	The date when this Framework was created
`id`	The ID of the Framework
`title`	The title of the Framework
`updated_at`	The date the Framework was last updated

Securityheader_authorization

Request

query Parameters

include	boolean Set to true along with relationships to return the entire relationship data in the `included` key within the response.
page	integer Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.
per_page	integer Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page.
q	string Search and filter the Framework data using Lucene syntax.
relationships	boolean Set to true to return the associated relationships data within the response. (default: false)

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

default

get/frameworks

Request samples

Response samples

default

application/json

[{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"applicable_controls_count": 0,
"applicable_framework_requirements_count": 0,
"at_risk_test_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"discarded_at": "2019-08-24T14:15:22Z",
"disabled_test_count": 0,
"failing_test_count": 0,
"title": "string",
"passing_test_count": 0,
"updated_at": "2019-08-24T14:15:22Z"
},
"relationships": { },
"links": { }
},
"includes": { }
}
]

Get a Framework

Returns a Framework by ID

Securityheader_authorization

Request

path Parameters

required

string

Scope response to id