canonical: https://jentic.com/apis/swaggerhub.hmcts-dts/hmcts-common-platform-case-administration-status-t # Hmcts Dts HMCTS Common Platform case administration status tracking APIs HMCTS Common Platform case administration status tracking APIs. The API exposes 2 endpoints secured with bearer authentication. ## For AI agents Programmatically healthcheck endpoint to get status of cp service, send status updates on transaction sent earlier. Covers 2 operations with bearer authentication. ## Scope Does not handle payments, communications, or crm - use for analytics only. ## Capabilities - Healthcheck endpoint to get status of CP service - Send status updates on transaction sent earlier - Integrate HMCTS Common Platform case administration status tracking APIs into automated workflows - Query and filter HMCTS Common Platform case administration status tracking APIs records by parameters - Monitor HMCTS Common Platform case administration status tracking APIs operational status and events ## Use cases ### Analytics Operations Use the HMCTS Common Platform case administration status tracking APIs to perform analytics operations programmatically. The API provides 2 endpoints covering core functionality including healthcheck endpoint to get status of cp service, send status updates on transaction sent earlier. Example prompt: Call GET /healthcheck to healthcheck endpoint to get status of cp service ### Data Retrieval and Monitoring Query HMCTS Common Platform case administration status tracking APIs resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed. Example prompt: Poll the primary HMCTS Common Platform case administration status tracking APIs endpoint, compare response to last known state, and alert if changed ### AI Agent Integration via Jentic AI agents discover and call HMCTS Common Platform case administration status tracking APIs endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually. Example prompt: Search Jentic for 'healthcheck endpoint to get status of cp service', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /healthcheck | Healthcheck endpoint to get status of CP service | | POST | /transaction/{transactionRef} | Send status updates on transaction sent earlier | ## Key resources - **Healthcheck** — Operations for healthcheck - **Transaction** — Operations for transaction ## Why Jentic - **Setup:** Wiring the HMCTS Common Platform status tracking API by hand means implementing its bearer token auth, coding the healthcheck and transaction calls, and handling retries yourself. Through Jentic you install once, import the status tracking API from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** This API puts the transaction reference in the URL path (/transaction/{transactionRef}), so a rule can pin your agent to one transaction: it can post status for that transaction and run the healthcheck and nothing else. You choose the operations it may call, so nothing beyond that set runs unless you add it. - **Credential handling:** Your status tracking API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'post status for a transaction' or 'check the service healthcheck', and Jentic returns the matching status tracking operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Mixpanel** — Alternative analytics API - **Amplitude** — Alternative analytics API - **Segment** — Complementary analytics API - **Pendo** — Complementary analytics API ## FAQ ### What authentication does the HMCTS Common Platform case administration status tracking APIs use? The HMCTS Common Platform case administration status tracking APIs uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I healthcheck endpoint to get status of cp service with the HMCTS Common Platform case administration status tracking APIs? Yes. Use the GET /healthcheck endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the HMCTS Common Platform case administration status tracking APIs? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I healthcheck endpoint to get status of cp service through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'healthcheck endpoint to get status of cp service'. Jentic returns the matching HMCTS Common Platform case administration status tracking APIs operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the HMCTS Common Platform case administration status tracking APIs have? The HMCTS Common Platform case administration status tracking APIs exposes 2 endpoints covering healthcheck, transaction operations. ### Can I limit what my agent is allowed to do with the HMCTS Common Platform case administration status tracking APIs? Yes. Jentic One is self-hosted, so your own rules decide which of this API's two operations the agent may call, GET /healthcheck and POST /transaction/{transactionRef}. Because the transaction reference sits in the URL path, you can pin the agent to a single transaction so it only posts status updates for that transaction and runs the healthcheck. Nothing outside the operations you allow will run unless you add it, and the bearer token stays with your instance rather than the agent context.