API docs by Redocly

OpenBKN Object Metrics V1 (1.0.0)

Download OpenAPI specification:

Versioned, object-centered metric authoring and lifecycle APIs.

getObjectMetricCapabilities

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "time_window_modes": [
    ],
  • "property1": [
    ],
  • "property2": [
    ]
}

listObjectMetrics

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
query Parameters
branch
string
Default: "main"
owner_object_type_id
string
metric_type
string (ObjectMetricType)
Enum: "atomic" "derived" "composite"
status
string (LifecycleStatus)
Enum: "draft" "validated" "published" "deprecated"
keyword
string
offset
integer >= 0
Default: 0
limit
integer [ 1 .. 500 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total_count": 0
}

createObjectMetricDraft

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
query Parameters
branch
string
Default: "main"
Request Body schema: application/json
required
id
string

Ignored on create; protected on update.

version
integer >= 1
code
required
string^[a-z][a-z0-9_]*$
name
required
string non-empty
description
required
string non-empty
owner_object_type_id
required
string
metric_type
required
string (ObjectMetricType)
Enum: "atomic" "derived" "composite"
required
object
required
AtomicSpecification (object) or DerivedSpecification (object) or CompositeSpecification (object)
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": 1,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "owner_object_type_id": "string",
  • "metric_type": "atomic",
  • "result_semantics": { },
  • "specification": {
    },
  • "query_capabilities": { },
  • "lifecycle": { }
}

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}

validateObjectMetric

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
query Parameters
branch
string
Default: "main"
Request Body schema: application/json
required
id
string

Ignored on create; protected on update.

version
integer >= 1
code
required
string^[a-z][a-z0-9_]*$
name
required
string non-empty
description
required
string non-empty
owner_object_type_id
required
string
metric_type
required
string (ObjectMetricType)
Enum: "atomic" "derived" "composite"
required
object
required
AtomicSpecification (object) or DerivedSpecification (object) or CompositeSpecification (object)
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": 1,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "owner_object_type_id": "string",
  • "metric_type": "atomic",
  • "result_semantics": { },
  • "specification": {
    },
  • "query_capabilities": { },
  • "lifecycle": { }
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "issues": [
    ],
  • "output_shape": "summary"
}

previewObjectMetricContract

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
query Parameters
branch
string
Default: "main"
Request Body schema: application/json
required
id
string

Ignored on create; protected on update.

version
integer >= 1
code
required
string^[a-z][a-z0-9_]*$
name
required
string non-empty
description
required
string non-empty
owner_object_type_id
required
string
metric_type
required
string (ObjectMetricType)
Enum: "atomic" "derived" "composite"
required
object
required
AtomicSpecification (object) or DerivedSpecification (object) or CompositeSpecification (object)
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": 1,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "owner_object_type_id": "string",
  • "metric_type": "atomic",
  • "result_semantics": { },
  • "specification": {
    },
  • "query_capabilities": { },
  • "lifecycle": { }
}

Response samples

Content type
application/json
{
  • "validation": {
    },
  • "output_schema": { }
}

getObjectMetric

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}

updateObjectMetricDraft

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
integer >= 1
Request Body schema: application/json
required
id
string

Ignored on create; protected on update.

version
integer >= 1
code
required
string^[a-z][a-z0-9_]*$
name
required
string non-empty
description
required
string non-empty
owner_object_type_id
required
string
metric_type
required
string (ObjectMetricType)
Enum: "atomic" "derived" "composite"
required
object
required
AtomicSpecification (object) or DerivedSpecification (object) or CompositeSpecification (object)
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": 1,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "owner_object_type_id": "string",
  • "metric_type": "atomic",
  • "result_semantics": { },
  • "specification": {
    },
  • "query_capabilities": { },
  • "lifecycle": { }
}

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}

deleteObjectMetricVersion

Deletes exactly one version in the requested knowledge-network branch. Metric references are branch-local because a metric reference does not carry a branch. Published versions and versions referenced by any retained metric version cannot be deleted.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
required
integer >= 1

Responses

checkObjectMetricVersionDeletion

Checks the same branch-local constraints enforced atomically by DELETE. Blocker details are filtered by view permission; hidden blockers are reported only as a count.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "metric_id": "string",
  • "metric_name": "string",
  • "version": 1,
  • "status": "draft",
  • "deletable": true,
  • "blockers": [
    ],
  • "hidden_blocker_count": 0
}

createNextObjectMetricDraftVersion

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"

Responses

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}

listObjectMetricVersions

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

publishObjectMetricVersion

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}

validateSavedObjectMetricVersion

Runs authoritative validation for a saved draft and persists its lifecycle status as validated. Any later edit returns it to draft.

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}

deprecateObjectMetricVersion

Authorizations:
bearerAuth
path Parameters
kn_id
required
string
metric_id
required
string <uuid>
query Parameters
branch
string
Default: "main"
version
required
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "definition": {
    },
  • "owner_object_type_name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "creator": { },
  • "updater": { },
  • "create_time": 0,
  • "update_time": 0
}