API docs by Redocly

ActionSchedule (0.1.0)

Download OpenAPI specification:

Action Schedule management. An action schedule triggers an action type on designated instances according to a cron expression. All APIs are exposed under /api/bkn-backend/v1, require OAuth2 authentication, default the branch query parameter to main, and use Unix milliseconds for timestamps.

ActionSchedule

Create an action schedule

Creates a cron-triggered action schedule in a knowledge network branch. Requires application/json content type.

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

Request Body schema: application/json
required
name
required
string

Name, with a maximum length of 100

action_type_id
required
string

Action type ID, which must exist in the specified knowledge network and branch

cron_expression
required
string

Valid five-field cron expression

_instance_identities
required
Array of objects non-empty

Non-empty instance identity list. The JSON key has a leading underscore.

dynamic_params
object
status
string
Enum: "active" "inactive"

Defaults to inactive. When active, creation calculates the next run time.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "action_type_id": "string",
  • "cron_expression": "string",
  • "_instance_identities": [
    ],
  • "dynamic_params": { },
  • "status": "active"
}

Response samples

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

List action schedules

Lists action schedules in a knowledge network with pagination and optional name, action type, or status filtering.

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Business knowledge network ID

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

name_pattern
string

Fuzzy match by name. Defaults to empty.

action_type_id
string

Filter by bound action type. Defaults to empty.

status
string
Enum: "active" "inactive"

Filter by status. Defaults to all.

offset
integer <int64>
Default: 0

Offset, greater than or equal to 0. Defaults to 0.

limit
integer <int64>
Default: 10

Page size in the range [1, 1000]. A value of -1 returns all items without pagination.

sort
string
Default: "create_time"
Enum: "create_time" "update_time" "next_run_time" "last_run_time" "name"

Sort field

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

Sort direction

Responses

Response samples

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

Get an action schedule

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Business knowledge network ID

schedule_id
required
string

Action schedule ID

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "kn_id": "string",
  • "branch": "string",
  • "action_type_id": "string",
  • "cron_expression": "string",
  • "_instance_identities": [
    ],
  • "dynamic_params": { },
  • "status": "active",
  • "last_run_time": 0,
  • "next_run_time": 0,
  • "lock_holder": "string",
  • "lock_time": 0,
  • "creator": {
    },
  • "create_time": 0,
  • "updater": {
    },
  • "update_time": 0
}

Update an action schedule

Updates mutable schedule fields: name, cron expression, instances, or dynamic parameters. At least one is required. This endpoint does not update status or action type. Requires application/json content type.

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Business knowledge network ID

schedule_id
required
string

Action schedule ID

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

Request Body schema: application/json
required
name
string

Maximum length of 100

cron_expression
string

Valid cron expression. Recalculates next_run_time only when the schedule is active.

_instance_identities
Array of objects
dynamic_params
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cron_expression": "string",
  • "_instance_identities": [
    ],
  • "dynamic_params": { }
}

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "description": "string",
  • "solution": "string",
  • "error_link": "string",
  • "error_details": null
}

Change action schedule status

Activates or deactivates a schedule. Activation recalculates the next run time using the stored cron expression. Requires application/json content type.

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Business knowledge network ID

schedule_id
required
string

Action schedule ID

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

Request Body schema: application/json
required
status
required
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "description": "string",
  • "solution": "string",
  • "error_link": "string",
  • "error_details": null
}

Delete action schedules in batch

Deletes one or more schedules by ID list.

Authorizations:
OAuth2
path Parameters
kn_id
required
string

Business knowledge network ID

schedule_ids
required
string

Comma-separated action schedule ID list

query Parameters
branch
string
Default: "main"

Branch name. Defaults to main.

Responses

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "description": "string",
  • "solution": "string",
  • "error_link": "string",
  • "error_details": null
}