WSE · Schnittstellen

Betrieb & Status

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓WSE-Version

REST · JSONBearer-Authentifizierung

Betrieb & Status

ERP API Dokumentation

Healthchecks

Liveness Check

Return the liveness state.

Responses

Request samples

cURL
JavaScript / Node.js
Python
Java
PHP

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/health/live' \
  --header 'Accept: application/json'

Response samples

200
default

Content type

application/json

null

Readiness Check

Return readiness including database reachability and license lock state.

Responses

Request samples

cURL
JavaScript / Node.js
Python
Java
PHP

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/health/ready' \
  --header 'Accept: application/json'

Response samples

200
default

Content type

application/json

{"status": "ready",
"license": {"locked": true,
"lock_reason": "string",
"expired_within_grace": true,
"valid_to": "2019-08-24",
"grace_until": "2019-08-24"
}
}

Deployment Health Check

Share one bounded probe per process; retain at most one outstanding task.

Responses

Request samples

cURL
JavaScript / Node.js
Python
Java
PHP

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/health/deployment' \
  --header 'Accept: application/json'

Response samples

200
503
default

Content type

application/json

{"status": "ready",
"database": {"status": "ready",
"code": "ready"
},
"license": {"status": "ready",
"code": "ready"
},
"storage": {"status": "ready",
"code": "ready"
}
}