Export policy JSON to Excel

POST

/api/v1/policies/export

const url = 'https://localhost:10001/api/v1/policies/export';
const options = {
  method: 'POST',
  headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'},
  body: '{"controls":[{"citations":[{"title":"example","url":"example"}],"controlCode":"example","createdAt":"example","description":"example","id":1,"policyId":1,"title":"example","updatedAt":"example"}],"createdAt":"example","description":"example","iconUrl":"example","id":1,"name":"example","organizationId":1,"slug":"example","type":"Risk Management","updatedAt":"example","version":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://localhost:10001/api/v1/policies/export \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "controls": [ { "citations": [ { "title": "example", "url": "example" } ], "controlCode": "example", "createdAt": "example", "description": "example", "id": 1, "policyId": 1, "title": "example", "updatedAt": "example" } ], "createdAt": "example", "description": "example", "iconUrl": "example", "id": 1, "name": "example", "organizationId": 1, "slug": "example", "type": "Risk Management", "updatedAt": "example", "version": "example" }'

Accepts structured policy JSON and returns a downloadable Excel (.xlsx) workbook

Authorizations

BearerAuth

Request Body

Policy data

application/json

object

controls

Controls within the policy, omitted but populated in list operations

Array<object>

object

citations

Array<object>

object

title

string

url

string

controlCode

string

createdAt

string

description

string

integer

policyId

integer

title

string

updatedAt

string

createdAt

string

description

string

iconUrl

string

integer

name

string

organizationId

integer

slug

string

type

Risk Management, Internal, Regulatory, Custom

string

Allowed values: Risk Management Internal Regulatory Custom

updatedAt

string

version

string

Responses

200

Excel file

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

file

400

Bad request - Invalid policy JSON

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

object

key

additional properties

string

500

Internal server error

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

object

key

additional properties

string