CoreOne Application Program Interface (API)

Introduction

DEPRECATED - The API V1 is still delivered with every installation. However, no new features will be added anymore. New features and changes will only be published in API V2.

Information from the CoreOne Suite can be queried and mutated via the CoreOne Application Program Interface (API). The Application Program Interface is based on the Open Data Protocol (oData) and can thus be easily accessed from all technologies. Further information about oData can be found on the official website:

http://www.odata.org/

The CoreOne Application Program Interface is accessible on the respective installation via the following URL:

https://demo.itsense.ch:8000/api/

Authentication

In order to call the CoreOne Application Program Interface (API), an Access Token is required. More information about this can be found in the following article:

Get Access Token

OpenID User

All provisioned OpenID users can be required via the following URL:

https://demo.itsense.ch:8000/api/Users/

The oData protocol can be used to filter and sort the endpoint data. For example, if you want a list sorted by creation date of all users with an activation code and a creation date, bigger than 15.1.2017, you call the interface as follows.

https://demo.itsense.ch:8000/api/Users/?$orderby=CreationDate&$filter=(ActivationCode ne null and CreationDate gt 2017-11-15T00:00:00.00Z)

The individual parameters of the call are broken down:

Parameter

Definition

Parameter

Definition

orderby

Sort Parameter

filter

oData anoted Filter

The API V1 doesn’t support Multi-Value attribute, they can only, these can only be read out via the API V2

How-to articles



Related articles



© ITSENSE AG. Alle Rechte vorbehalten. ITSENSE und CoreOne sind eingetragene Marken der ITSENSE AG.