API-V2 Swagger Documentation

Introduction

The CoreOne Suite Application Interface publishes a Swagger documentation on the server. For the full documentation use the following URL on your installation:

The result should look like this:

Open

From Version 8

From Version 8 Pilatus and onward the swagger documentation is separated into two spaces extended and generated.

The generated space includes all the generated entity endpoints for the CRUD operations. They are focused on a specific entity and normally don’t feature a lot of business logic.

Open

On the other hand, the extended space holds the more business-driven endpoints and extends the basic CRUD operation with more business logic or logic that isn’t related to an entity at all.

To switch between the two spaces you have to enter either /apiv2/swagger/docs/extended or /apiv2/swagger/docs/generated in the text field on the top.