JSON Schema API

/_/jsonSchemas

/_/jsonSchemas get

get

Get JSON Schemas for the given module defined by header X-Okapi-Module-Id. Without path query param will return list of JSON Schema paths. With path query param will return the specific JSON Schema with resolvable references.

Request
Response

Query Parameters

path: (string)
Path to specific JSON Schema
Example:
```
userdata.json
```

HTTP status code 200

JSON Schema

Body

Media type: application/json

Type: any

Example:

[
  "userdataCollection.json",
  "usergroups.json",
  "proxyfor.json",
  "userdata.json",
  "proxyforCollection.json",
  "usergroup.json",
  "addresstype.json",
  "addresstypeCollection.json"
]

Media type: application/schema+json

Type: any

HTTP status code 404

JSON Schema with a given path not found

Body

Media type: text/plain

Type: any

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

JSON Schema API version v1

JSON Schema API

/_/jsonSchemas

/_/jsonSchemas get

get /_/jsonSchemas

Query Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body