Skip to content

Output Formats

The format query parameter on /rules/{rule_id_path} selects the serialisation of the response. Seven values are accepted.

cprmv-json (default)

A custom recursive JSON format produced directly from rdflib's graph traversal, not from RDF serialisation. The response is a nested dictionary that mirrors the cprmv:hasPart tree of the rule:

{
    "https://standaarden.open-regels.nl/standards/cprmv/0.4.0/#id": "Artikel 20",
    "https://standaarden.open-regels.nl/standards/cprmv/0.4.0/#definition": "...",
    "https://standaarden.open-regels.nl/standards/cprmv/0.4.0/#hasPart": {
        "lid 1": {
            "https://standaarden.open-regels.nl/standards/cprmv/0.4.0/#id": "lid 1",
            "https://standaarden.open-regels.nl/standards/cprmv/0.4.0/#definition": "...",
            "https://standaarden.open-regels.nl/standards/cprmv/0.4.0/#hasPart": {
                "onderdeel a": { ... }
            }
        }
    }
}

All sub-rules contained via cprmv:hasPart RDF lists are recursively included. Predicate URIs are used as keys.

Note

When unformat is also provided, the format is forced to cprmv-json regardless of the format value. The named fields extracted by the parse pattern are merged into the top-level JSON object.

RDF formats

For all non-cprmv-json formats, the API serialises the Concise Bounded Description (CBD) of the matched rule node using rdflib's serialiser:

format value Media type Notes
json-ld application/ld+json JSON-LD 1.1
turtle text/turtle Standard Turtle
ttl text/turtle Alias for turtle
turtle2 text/turtle rdflib's alternative Turtle serialiser
n3 text/n3 Notation3
xml application/rdf+xml RDF/XML

The CBD includes all triples directly about the matched rule node. Nested sub-rules referenced via cprmv:hasPart RDF lists are included because the list blank nodes form part of the CBD.

Methods endpoint format

The /methods endpoint accepts the same set of RDF format strings (json-ld, xml, turtle, ttl, n3, turtle2) and serialises the entire Methods Knowledge Graph, which contains both cprmv.ttl and cprmvmethods.ttl.