API docs by Redocly

ActionType (0.1.0)

Download OpenAPI specification:

List action types

path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
name_pattern
string

Fuzzy match by 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.

action_type
string
Enum: "add" "modify" "delete"

Query filter: filter by action category enum using the same value domain as action_type and action_intent in the response.

object_type_id
string

Bound object type

branch
string
Default: "main"

Branch. Defaults to main.

Responses

Response samples

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

Create or retrieve action types

path Parameters
kn_id
required
string

Business knowledge network ID

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 bound and affected object types. When false, missing dependencies do not cause an error.

branch
string
Default: "main"

Branch. Defaults to main.

header Parameters
x-http-method-override
required
string
Enum: "POST" "GET"

Request override header

Request Body schema: application/json
required
required
Array of objects (ReqActionType)

Action type information

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "entries": [
    ],
  • "total_count": 2,
  • "next_cursor": "cursor-action-types-1"
}

Update an action type

path Parameters
kn_id
required
string

Business knowledge network ID

at_id
required
string

Action type 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 bound and affected object types and other dependencies. When false, skips validation.

Request Body schema: application/json
required
name
required
string

Action type name

tags
Array of strings

Tags. May be empty.

comment
string

Comment. May be empty.

icon
string

Icon

color
string

Color

branch
required
string

Branch ID

action_type
required
string
Deprecated
Enum: "add" "modify" "delete"

Deprecated. Prefer action_intent; dual writes must agree.

action_intent
string
Enum: "add" "modify" "delete"

Recommended field stored in f_action_intent.

object_type_id
required
string

Object type ID bound to the action type

action_condition_and (object) or action_condition_or (object) or action_condition_eq (object) or action_condition_not_eq (object) or action_condition_gt (object) or action_condition_gte (object) or action_condition_lt (object) or action_condition_lte (object) or action_condition_in (object) or action_condition_not_in (object) or action_condition_range (object) or action_condition_out_range (object) or action_condition_exist (object) or action_condition_not_exist (object) (ActionCondition)
object
Deprecated

Deprecated. Use impact_contracts.

Array of objects (ImpactContractItem)

Stored in f_impact_contracts as JSON.

ToolSource (object) or MCPSource (object)

Resource bound to the action

Array of objects (Parameter)

Action resource parameters

object (Schedule)

Execution frequency configuration

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tags": [
    ],
  • "comment": "string",
  • "icon": "string",
  • "color": "string",
  • "branch": "string",
  • "action_type": "add",
  • "action_intent": "add",
  • "object_type_id": "string",
  • "condition": {
    },
  • "affect": {
    },
  • "impact_contracts": [
    ],
  • "action_source": {
    },
  • "parameters": [
    ],
  • "schedule": {
    }
}

Get action type details

path Parameters
kn_id
required
string

Business knowledge network ID

at_ids
required
Array of strings

Action type ID

query Parameters
branch
string
Default: "main"

Branch. Defaults to main.

Responses

Response samples

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

Delete an action type

path Parameters
kn_id
required
string

Business knowledge network ID

at_ids
required
Array of strings

Action type ID

query Parameters
branch
string
Default: "main"

Branch. Defaults to main.

Responses

Validate action types

Validates only action type dependency existence and does not persist data. It validates dependencies such as bound and affected object types.

Response: HTTP 200 with valid and detail follows the other validation APIs. Parameter and authentication errors are non-2xx.

Internal API: the corresponding internal path 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 action type creation and validates conflicts with persisted action type IDs or names using normal, ignore, or overwrite.

Request Body schema: application/json
required
entries
Array of objects

Action types to validate. Uses the same structure as the creation API.

Responses

Request samples

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

Response samples

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