Export an SAP/SAR Master Assessment as a Microsoft Word document.

get https://{baseUrl}/api/documents/sapSarExport/{module}/{intId}/{relatedModule}/{relatedId}/{type}

Path Params

module

string

required

The module ID.

intId

int32

required

The parent SSP ID.

relatedId

int32

required

The ID of the related SSP.

relatedModule

string

required

The ID of the related module.

type

string

required

The type of format to generate. Not case-sensitive. Valid options are:

        - sar

        - fedrampsap

Query Params

exportOptions

string

A comma-separated list of export options. Optional, not case-sensitive, only
implemented for SAR export. Valid options are:

        - highlightmissing

version

string

Responses

400

The given type doesn't match allowed formats.

      - The document could not be created; the server logs have more information.

401

The caller is not authenticated with RegScale.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://your-instance.regscale.co/api/documents/sapSarExport/module/intId/relatedModule/relatedId/type \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
true

200The file stream for the Microsoft Word document.