Policies API - DRAFT

GET

/policies

Returns a paginated list of all question policies. Default number of policies per page is 25.

GET

/policies?search=

Returns a paginated list of all policies containing the search criteria.

type a string after the equals sign

POST

/policies

Creates a new question policy

{

“framework”:“string”,

”section”:”string”,

“assets”:[], (nothing here)

“questions”:[{“id”:”<question id*>”},…],

}

*Question id can be obtained from using the GET command on the /questions endpoint to retrieve a list of all questions and their id’s

PUT

/policies/<policy id>

Replaces an existing policy with an entirely new one

Use same format as above

**Note: Console says you must provide a changelog entry but I do not know how to format that in the API

PATCH

/policies/<policy id>

Replaces certain details of an existing policy

ex.)

{

“framework”:”new framework name”

}

**Note: Console says you must provide a changelog entry but I do not know how to format that in the API

DELETE

/policies/<policy id>

Deletes the specified policy