GET /route

Ratkaisee yksittäisen reitin annetulle polulle. Täsmälleen vastaava polku voittaa; muussa tapauksessa valitaan parhaiten pisteytetty parametrinen kuvio, sen sidotut parametrit validoidaan asiakirjoja vasten ja tulokselliset lohkot lasketaan. Vaihtoehtoisesti palauttaa ratkaistut parametriasiakirjat.

Todennus: API-avain (x-api-key-otsake tai api_key-kyselyparametri).

Kyselyparametrit

Vastaus

{
  "route": {
    "path": "/docs/us/guide",
    "pattern": "/docs/{country}/guide",
    "block_ids": ["..."],
    "state": "Julkaistu",
    "param_bindings": { "country": "maa" }
  },
  "resolvedParams": {
    "country": {
      "value": "us",
      "schemaName": "maa",
      "document": { "id": "...", "schema_name": "maa", "title": "Yhdysvallat", "published_content": {} }
    }
  }
}

route-objekti on samanmuotoinen kuin vastaus kohteesta GET /routes. resolvedParams-kenttä on mukana vain, kun reitillä on parametrisidoksia ja vähintään yksi asiakirja on ratkaistu. Skeemaan language sidotut parametrit ratkaistaan sisäänrakennetusta tuettujen kielten luettelosta tietokannan sijaan.

Esimerkki

curl '{CMS_API_URL}/route?websiteId=<uuid>&path=/docs/getting-started' \
  -H 'x-api-key: <key>'

Virheet

• 400 — websiteId puuttuu tai on virheellinen, tai path puuttuu/tyhjä
• 401 — virheellinen API-avain
• 404 — reittiä ei löydy tai parametrien validointi epäonnistui (ellei skipValidation=true)