This is in beta. If you find something wrong, let us know

Definitions Catalogue

Getting Started

Collaborate

Using the API

Search

Browse

Details

Domains

Posting

Paths

Schema

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

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

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



Last edited: 26 Feb 2020, 09:55:12