Skip to content

System API

Basic system information

Warning

This api is obsolete and will be removed in future versions. Use GET /api/core/account/profile instead.

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

Optional Parameters:

  • setup true additional instance information (default false)
Response
JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "kv.v.api.token": "true",
  "kv.v.api.url": "https://app.platformaerp.com",
  "kv.v.api.version": "0000",
  "kv.v.owner.language": "pl",
  "kv.v.owner.name": "IT SOLUTIONS Marcin Kotynia",
  "kv.v.user.app_name": "erp",
  "kv.v.user.currency": "EUR",
  "kv.v.user.teamid": "84A43F6B-7E3C-B7CD-A68B-48DA22024540",
  "kv.v.user.userid": "A83D6E10-03C0-4687-BB3F-7AF9DE04427D",
  "kv.v.user.username": "[email protected]",
  "kv.v.user.apps": [
    "app-client",
    "cenniki"
  ]
}

Generate html from markdown

HTTP
1
2
3
4
5
6
7
POST {{host}}/api/core/system/preview
Authorization: Basic api:{{token}}

{
    "painput": "# Hello World \n- line1\n- line2",
    "patype": "" //optional type default markdown
}

GET Sql Server friendly UUID v7

Warning

This uuids are designed specifically for SQL Server. They are not compatible with other systems.

Single

HTTP
1
2
GET {{host}}/api/core/system/uuid
Authorization: Basic api:{{token}}

Multiple

Parameters:

  • n - number of uuids to generate
HTTP
1
2
GET {{host}}/api/core/system/uuids?n=10
Authorization: Basic api:{{token}}

Response

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
[
  "759f534c-2957-8a70-83cf-018f54b2dbca",
  "a4769e89-1c87-8f2b-87f7-018f54b2dbcb",
  "dd853419-d0b3-86fa-87f8-018f54b2dbcb",
  "de21ccc0-5294-8f5e-87f9-018f54b2dbcb",
  "bf4d508a-dbcb-8ced-87fa-018f54b2dbcb",
  "8adafac5-dc8a-835e-87fb-018f54b2dbcb",
  "0c8ab3bf-bca6-8196-87fc-018f54b2dbcb",
  "87521b6a-8704-8fd0-87fd-018f54b2dbcb",
  "de269ee0-2cc5-8920-87fe-018f54b2dbcb",
  "510f3aea-4655-823a-87ff-018f54b2dbcb"
]

Ping , test method

HTTP
1
2
3
4
curl {{host}}/api/core/system/ping \
-H "Content-Type: application/json" \
-H "Authorization: Token {{token}}" \
-d "{'key1':'value1', 'key2':'value2'}"

By default curl sends data as form data (application/x-www-form-urlencoded) jetQuery will convert it to json on the fly.

HTTP
1
2
3
curl -u api:{{token}} {{host}}/api/core/system/ping \
-H "Authorization: Token {{token}}" \
-d 'key1=value1&key2=value23'