API docs by Redocly

BusinessKnowledgeNetwork (0.1.0)

Download OpenAPI specification:

List business knowledge networks

query Parameters
name_pattern
string

Fuzzy match by business knowledge network name. Defaults to empty.

sort
string
Enum: "update_time" "name"

Sort type. Defaults to update_time.

direction
string
Enum: "asc" "desc"

Sort direction. Supported values are asc and desc. Defaults to desc.

offset
integer <int64>

Offset of the first returned item. Must be greater than or equal to 0. Defaults to 0.

limit
integer <int64>

Maximum number of items returned per page. Pagination accepts 1 through 1000, and -1 disables pagination. Defaults to 10.

tag
string

Exact match by tag. Defaults to empty.

Responses

Response samples

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

Create a business knowledge network

query Parameters
import_mode
string
Enum: "normal" "ignore" "overwrite"

Import mode. Supported values are normal, ignore, and overwrite. Defaults to normal.

strict_mode
boolean
Default: true

Whether to strictly validate dependencies. Defaults to true. When true, validates dependencies such as object type and relation type views. When false, missing dependencies do not cause an error.

validate_dependency
boolean
Deprecated
Default: true

Deprecated. Use strict_mode instead. This parameter is retained for compatibility and is read when strict_mode is empty.

branch
string
Default: "main"

Branch. Defaults to main.

Request Body schema: application/json
required
id
string

Business knowledge network ID. Immutable after creation. May contain lowercase letters, digits, underscores, and hyphens, and cannot start with an underscore or hyphen.

name
required
string

Business knowledge network name

tags
Array of strings

Tags used for business identification

comment
string

Comment

icon
string

Icon

color
string

Color

branch
required
string

Branch ID

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "comment": "string",
  • "icon": "string",
  • "color": "string",
  • "branch": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get business knowledge network details

Gets ontology model details and includes specification content when requested.

path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
mode
string
Enum: "" "export"

Query mode. Currently supports export. By default, returns only knowledge network details and not included child types.

include_statistics
boolean

Whether to include statistics for concepts under the business knowledge network. Defaults to false.

branch
string
Default: "main"

Branch. Defaults to main.

detail_level
string
Default: "full"
Enum: "full" "summary"

Response detail level. full returns complete definitions; summary returns only concept IDs and names for progressive loading of large knowledge networks. Defaults to full.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "kn_system_incident_event_network",
  • "name": "DIP系统故障事件网络",
  • "tags": [
    ],
  • "comment": "DIP系统故障事件网络。。。。。。。。。。。。",
  • "icon": "",
  • "color": "",
  • "branch": "main",
  • "creator": "a0f02238-6cec-11f0-82bb-fa1c4529a151",
  • "create_time": 1757583140948,
  • "updater": "a0f02238-6cec-11f0-82bb-fa1c4529a151",
  • "update_time": 1757583140948,
  • "detail": "markdown文本"
}

Update a business knowledge network

path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
branch
string

Branch. Uses main when omitted.

strict_mode
boolean
Default: true

Whether to strictly validate dependencies. Defaults to true. When true, validates dependencies for nested object types, relation types, action types, and concept groups in the request. When false, skips validation.

import_mode
string
Default: "normal"
Enum: "normal" "overwrite" "ignore"

Import mode. normal reports an error for duplicate concept names; overwrite replaces them; ignore skips them. Defaults to normal.

Request Body schema: application/json
required
name
required
string

Business knowledge network name

tags
Array of strings

Tags used for business identification

comment
string

Metric model comment

icon
string

Icon

color
string

Color

branch
required
string

Branch ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tags": [
    ],
  • "comment": "string",
  • "icon": "string",
  • "color": "string",
  • "branch": "string"
}

Delete a business knowledge network

Deletes a business knowledge network and all of its object types, relation types, action types, and concept groups.

path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
branch
string
Default: "main"

Branch. Defaults to main.

Responses

Validate a business knowledge network

Validates only knowledge network dependency existence and does not persist data. It validates all dependencies including object types, relation types, action types, and concept groups. The server builds one BatchIDIndex from the four top-level request buckets and nested concept_groups buckets, allowing references to types present only in nested groups.

Response: HTTP 200 indicates processing completed. valid=true means validation passed; valid=false means validation failed or an error occurred, with detail explaining the cause. Invalid bodies, invalid strict_mode, missing knowledge networks, and authorization failures return non-2xx responses.

Internal API: the corresponding internal path uses the same request and response contract, resolves the caller from headers, and does not use OAuth.

path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
branch
string

Branch. Uses main when omitted.

strict_mode
boolean
Default: true

Whether to strictly validate dependencies. Defaults to true.

import_mode
string
Default: "normal"
Enum: "normal" "ignore" "overwrite"

Matches creation semantics. When neither import_mode nor mode is provided, uses normal. It validates persisted ID and name conflicts with normal, ignore, and overwrite semantics.

Request Body schema: application/json
required
object_types
Array of arrays
relation_types
Array of arrays
action_types
Array of arrays
concept_groups
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "object_types": [ ],
  • "relation_types": [ ],
  • "action_types": [ ],
  • "concept_groups": [ ]
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "detail": "string"
}