Skip to main content
POST
Parse a ReqIF document into a flow-shaped preview

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Body

application/json
reqif
string
required

The ReqIF document XML to parse. Either the raw contents of a .reqif file or the body of its CORE-CONTENT — the parser reads DATATYPES, SPEC-TYPES, SPEC-OBJECTS, SPECIFICATIONS and SPEC-RELATIONS.

mapping
object

Optional import mapping that renames reqif types/fields to flow names and configures per-field behaviour (extract_string, multiple_choice, convert_to, enum tag renames). Omit to use the reqif names verbatim (equivalent to the file-derived default schema).

Response

200 - application/json

Parsed entities, links and the file-derived default schema

defaultSchema
object
entities
object[]