API docs by Redocly

BKN Backend API (1.0.0)

Download OpenAPI specification:

BKN (Business Knowledge Network) Backend API provides import and export operations for business knowledge networks.

BKN Import/Export

BKN import and export APIs

Upload and import a BKN tar archive

Upload a BKN tar archive and import it as a business knowledge network. For the archive format, see docs/design/bkn/features/bkn_docs/SPECIFICATION.md

Authorizations:
OAuth2
query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

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.

strict_mode
boolean
Default: true

Whether to validate that dependent objects exist. Defaults to true. When empty, the deprecated validate_dependency parameter is used.

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.

header Parameters
X-Business-Domain
required
string

Business domain

Request Body schema: multipart/form-data
required
file
string <binary>

BKN tar archive file

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string"
}

Download a BKN tar archive

Export a business knowledge network as a BKN tar archive. For the archive format, see docs/design/bkn/features/bkn_docs/SPECIFICATION.md

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Knowledge network ID

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

Responses

BKN

Batch get knowledge network names by ID

Batch return knowledge network names by ID, for example for object-level authorization pages. Missing IDs are skipped without an error. Requires application/json content type.

Authorizations:
OAuth2
Request Body schema: application/json
required
ids
Array of strings <= 100 items

List of knowledge network IDs to resolve, with at most 100 items. An empty list returns empty entries.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

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

List resources

Lists resources by resource type with pagination on the unified resource platform. Currently supports resource_type=knowledge_network.

Authorizations:
OAuth2
query Parameters
resource_type
required
string
Value: "knowledge_network"

Resource type. The current implementation recognizes only knowledge_network, which represents a knowledge network. It maps to interfaces.RESOURCE_TYPE_KN.

Other values do not return an error. Instead, the default branch returns 200 with an empty response body. This is not an empty list: there is no body at all. An invalid value causes the client to fail JSON parsing or receive no data, rather than receive a 400 response.

keyword
string

Filter by name keyword. Defaults to empty.

offset
integer <int64>
Default: 0

Offset. Defaults to 0.

limit
integer <int64>
Default: 10

Page size. Defaults to 10.

sort
string
Default: "name"

Sort field. Defaults to name.

direction
string
Default: "desc"
Enum: "asc" "desc"

Sort direction. Defaults to desc.

Responses

Response samples

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