Begäran
- Content-Type: application/json
- Skicka JSON-skrivningar med Content-Type: application/json.
- data · meta
- Lyckade svar innehåller data och meta. Svar med samlingar beskriver dessutom paginering.
- error.code · error.message
- Fel innehåller error.code, error.message och, när det är relevant, fältinformation.
Datatyper
- Obligatoriskt och nullable är oberoende egenskaper.
- Ett obligatoriskt fält kan innehålla null om schemat tillåter det.
- Bevara JSON-värdenas typer: booleska värden, heltal, strängar och null.
- Belopp anges som decimalsträngar.
- Beräkna inte priser med binära flyttal.
64-bit · expected_version
- Vissa versionsvärden för samtidighetskontroll är signerade 64-bitars heltal.
- En JavaScript-klient måste använda förlustfri JSON-hantering för värden över Number.MAX_SAFE_INTEGER och skicka den ursprungliga heltalsrepresentationen.
- Avrunda inte versionen och gör inte om den till en JSON-sträng.
HTTP-huvuden
Cache-ControlSträngValfrittRegler för cachelagring av svaret.
const:"no-store"X-Correlation-IDSträngValfrittIdentifierare för spårning av denna HTTP-begäran.
WWW-AuthenticateSträngValfrittAutentiseringsschema som servern kräver.
AllowSträngValfrittHTTP-metoder som resursen stöder.
Retry-AfterHeltalValfrittMinsta väntetid före ett nytt försök, i sekunder.
minimum:0LocationSträngValfrittRelativ URL till den skapade resursen.