Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents
maxLevel1
typeflat

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]

Code Block
/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]

Code Block
/coreidentities/771

Returns a specific object

405 - Method not allowed

Replaces an object 

Update a specific object

Deletes a single object

/[Entitätstyp]/fields

Code Block
/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

Code Block
/coreidentities/custommethod

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

Code Block
/coreidentities/711/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

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel in ( "openid" , "apiv2-rest" ) and label in ( "openid" , "apiv2-rest" ) and label = "how-to" and type = "page" and space = "IKB"

Related article

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
cqllabel in ( "openid" , "apiv2" ) and label = "apiv2" and type = "page" and space = "IKB"