Definitions Catalogue
Paths
Finds definitions by their id
get /api/definition/{domain}/{id}
Parameters
Where | Name | Description | Schema | Required |
:--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
path | domain | The shorthand name of a domain. E.g. 'sbr' for Standard Business Reporting and 'fs' for Financial Statistics | string | true |
path | id | The id of an item. E.g. 'de55' | string | true |
Responses
HTTP Code | Description | Schema |
:--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
200 | OK | #/components/schemas/Definition |
Tags
- definitions
Browse through all the definitions
get /api/browse
Parameters
Where | Name | Description | Schema | Required |
:--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
query | page | Which result page | integer | false |
query | size | How many results per page | integer | false |
Responses
HTTP Code | Description | Schema |
:--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
200 | OK | #/components/schemas/Results |
Tags
- definitions
Search for definitions
get /api/search
Parameters
Where | Name | Description | Schema | Required |
:--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
query | query | The search term | string | true |
query | domain | Which domain to search within. Defaults to '', which searches all domains. Domains are specified by their shorthand notation, e.g. 'sbr' for Stand | string | false |
query | page | Which result page | integer | false |
query | size | How many results per page | integer | false |
Responses
HTTP Code | Description | Schema |
:--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
200 | OK | #/components/schemas/Results |
Tags
- search