API

REST API based on ontologies.

The DTXS data transfer protocol is a client-server  RESTful API. This means that to work with the data stored on the server, you must do a request to the DTXS server.

Furthermore, based on the particular implementation of the server, you might be required to be authorized, e.g. by OAuth2 authorization server, and use access tokens to secure your communication with the server.

In this chapter, the endpoints for the DTXS API are described, as well as requests to those endpoints and expected responses.

content attribute

Many DTXS requests and responses contain an attribute called content. This attribute, its structure and its content strongly depends on the ontology class to which the content is related.

For example, a record can be classified as ndo:Actors.Persons.

class attribute

Many DTXS requests and responses contain an attribute called class. This attribute is used to classify a record, document or a stream into an ontology class. For example, a record can be classified under

For example, content of record classified as ndo:Actors.Persons will be different than the content of record classified as ndo:Safety.Regulatory.Frameworks

REST API

Every DTXS server should expose the REST API compatible with the DTXS standard. This chapter describes the structure of requests and expected responses of the DTXS-compatible server.

Sample client

There is a sample implementation of DTXS client available. Read more about it here.