Export an SSP Component as a Microsoft Word document.

get https://{baseUrl}/api/documents/componentExport/{module}/{intId}/{relatedId}/{type}/{exportOptions}

Path Params

module

string

required

The module ID.

intId

int32

required

The parent SSP ID.

type

string

required

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

        - fedramp

        - cmmc-ssp

        - cmmc-component

        - tailored

        - sar

        - fedrampsap

        - doe

relatedId

int32

required

The parent ID or other ID related to the component.

exportOptions

string

required

Export options string (e.g., 'full' or 'summary')

Query Params

exportOptions

string

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

        - highlightmissing

Responses

400

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/componentExport/module/intId/relatedId/type/exportOptions \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
true

200The file stream for the Microsoft Word document.