API-V2 REST Interface
- Marco Suter (Unlicensed)
- Silvan Grüter
- Christina Burkhard
Introduction
Information from the CoreOne Suite can be queried and changed via the CoreOne application program Interface V2 (API-V2). The Application Program Interface is based on the REST protocol and can therefor be easily addressed from all technologies. The CoreOne Application Program Interface V2 can be reached on the respective installation via the following URL: https://demo.itsense.ch:8000/apiv2/
Authentication
An access Token is required to be able to call the CoreOne Application Program Interface V2 (API V2). You can find more information on this in the following article: Access Token lösen
Versioning
The API supports versioning. In the documentation we use the {apiversion} syntaxt to indicate the version. To use the lastest simply replace it with latest.
HTTP-Routes
GET (read) | POST (create) | PUT (Create or replace) | PATCH (Update) | DELETE (delete) | |
|---|---|---|---|---|---|
/[Entitätstyp] /coreidentities | Returns a list of objects | Creates an object Or: Creates multiple objects at once | 405 - Method not allowed | Update of individual object properties for several objects at the same time | Deletes multiple objects at once |
/[Entitätstyp]/[EntitätsId] /coreidentities/771 | Returns a specific object | 405 - Method not allowed | Replaces an object | Update a specific object | Deletes a single object |
/[Entitätstyp]/fields /coreidentities/fields | Returns a list of all available properties of an object | 405 - Method not allowed | 405 - Method not allowed | 405 - Method not allowed | 405 - Method not allowed |
/[Entitätstyp]/method | Executes a specific method for all objects in the list (Filtered) | Executes a specific method for all objects in the list (Filtered) | Executes a specific method for all objects in the list (Filtered) | Executes a specific method for all objects in the list (Filtered) | Executes a specific method for all objects in the list (Filtered) |
/[Entitätstyp]/[EntitätsId]/custommethod | Executes a specific method on a single object | Executes a specific method on a single object | Executes a specific method on a single object | Executes a specific method on a single object | Executes a specific method on a single object |
How-to article
Related article
© ITSENSE AG. Alle Rechte vorbehalten. ITSENSE und CoreOne sind eingetragene Marken der ITSENSE AG.