Skip to content
NorthplaneNorthplane

Evaluated BPI tree with live status

GET
/api/v1/business-services:tree
curl --request GET \
  --url https://example.com/api/v1/business-services:tree \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
Array<object>
object
causes
Array<string>
children
Array<object> recursive
service
object
createdAt
required
string format: date-time
excludeDowntimes
boolean
id
required
string
name
required
string
objectId
string
parentId
string
quorumPct
number
rule
string
selector
string
slaTarget
number
slaWindow
string
tenantId
required
string
updatedAt
required
string format: date-time
version
required
integer
weight
number
state
required
integer
Examplegenerated
[
  {
    "causes": [
      "example"
    ],
    "children": [],
    "service": {
      "createdAt": "2026-04-15T12:00:00Z",
      "excludeDowntimes": true,
      "id": "example",
      "name": "example",
      "objectId": "example",
      "parentId": "example",
      "quorumPct": 1,
      "rule": "example",
      "selector": "example",
      "slaTarget": 1,
      "slaWindow": "example",
      "tenantId": "example",
      "updatedAt": "2026-04-15T12:00:00Z",
      "version": 1,
      "weight": 1
    },
    "state": 1
  }
]

default

Section titled “default”

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}