Export an SSP Component as an OSCAL-formatted XML file.

get https://{baseUrl}/api/documents/oscalExport/{module}/{intId}/{format}/{type}/{exportOptions}

Path Params

module

string

required

The module ID.

intId

int32

required

The parent SSP ID.

format

string

required

Whether or XML or JSON (JSON not currently used)

type

string

required

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

        - SSP, SAP, SAR, POAM

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 this export. Defaults to rev5 and 1.1.1 when not specfied. Valid options are:

        - rev4 or rev5 - specific NIST 800-53 version

        - 1.0.4 or 1.1.1 - specific OSCAL  version

        - examples (true,rev4,1.0.4 or true,rev5,1.1.1)

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


xxxxxxxxxx
 
1
true

200The file stream for the XML document.