Core API

The Core API serves as the gateway to the platform's fundamental capabilities. It facilitates the management of users, groups, permissions, and other essential features integral to the operation of the platform.

Together, the Core API and the Simple Report Service (SRS) API form the foundational components for application development within the platform.

If you are new to the platform, you can start by reading the Getting Started guide to learn how to authenticate and access API.

To test the availability, you can use the following GET/POST request:

GET

curl {{host}}/api/core/system/ping \
-H "Authorization: Token {{token}}" \

Optional Parameters:

• statusCode - integer - 200
• success - boolean - true
• body - json

Response

{
  "success": true,
  "message": "OK",
  "requestID": "",
  "executed_at": "2050-01-01T00:00:00.123456Z",
  "data": {
    "items": {
      "authenticated": true,
      "username": "[email protected]",
      "version": "0000"
    },
    "body": null
  }
}

POST json

curl -X POST {{host}}/api/core/system/ping \
-H "Authorization: Token {{token}}" \
-H "Content-Type: application/json" \
-d "{ 'name': 'John','Age': 23,'Male':true}" \

Response

{
  "success": true,
  "message": "OK",
  "requestID": "",
  "executed_at": "2050-01-01T00:00:00.123456Z",
  "data": {
    "items": {
      "authenticated": true,
      "username": "[email protected]",
      "version": "0000"
    },
    "body": {
      "name": "John",
      "Age": 23,
      "Male": true
    }
  }
}

POST www-form-urlencoded

curl -X POST {{host}}/api/core/system/ping \
-H "Authorization: Token {{token}}" \
-d "name=John&Age=23&Male=true" \

Response

{
  "success": true,
  "message": "OK",
  "requestID": "",
  "executed_at": "2050-01-01T00:00:00.123456Z",
  "data": {
    "items": {
      "authenticated": true,
      "username": "[email protected]",
      "version": "0000"
    },
    "body": {
      "name": "John",
      "Age": "23",
      "Male": "true"
    }
  }
}