Skip to main content
POST
Get Or Create SOV Output

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string
required

SOV ID or SUD ID.

Body

output_format
string
required

The desired output format.

Minimum string length: 1
job_id
string<uuid> | null

If provided, associate with this existing job instead of creating a new one.

overwrite_existing
boolean
default:false

If true, regenerate the output file even if it already exists.

revision
integer
default:-1

The revision number of the SOV to use, -1 is the latest, 0 is the initial SOV (this field is ignored when a SUD ID is provided).

Response

201 - application/json

SOV output response with request status and result if already available.

request
object
required

Information about the request status.

result
object

Result if the file is already available.