Skip to content

API and admin interface to manage object definitions.

License

Notifications You must be signed in to change notification settings

maykinmedia/objecttypes-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Objecttypes API

Version: 2.2.2
Source:https://github.com/maykinmedia/objecttypes-api
Keywords:objects, assets, zaakobjecten

Documentation Status

API to manage object definitions. (Nederlandse versie)

Developed by Maykin Media B.V. commissioned by the Municipality of Utrecht.

Introduction

The Objecttypes API aims to standardize various types of objects, on a national level, in an accessible way and without the need to create a whole new API for each (simple) object.

This national Objecttypes API is required for registering objects in local Objects APIs. Organisations can also run an Objecttypes API locally, to use both national and local definitions of objects.

API specification

Lint OAS Generate SDKs Generate Postman collection

Version Release date API specification
latest n/a ReDoc, Swagger, (diff)
2.2.2 2022-08-23 ReDoc, Swagger (diff)
2.2.0 2022-06-24 ReDoc, Swagger (diff)
2.0.0 2021-10-04 ReDoc, Swagger (diff)

Previous versions are supported for 6 month after the next version is released.

See: All versions and changes

Reference implementation

Build status Coverage Code style Docker image Supported Python version

The reference implementation is used to demonstrate the API in action and can be used for test and demo purposes. The reference implementation is open source, well tested and available as Docker image.

Quickstart

  1. Download and run the Objecttypes API:

    wget https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/docker-compose.yml
    docker compose up -d --no-build
    docker compose exec -T web src/manage.py loaddata demodata
    docker compose exec web src/manage.py createsuperuser
  2. In the browser, navigate to http://localhost:8000/ to access the admin and the API.

References

License

Copyright © Maykin Media, 2020 - 2021

Licensed under the EUPL