본문으로 건너뛰기

EntityParameter

Shared request and response schema. Request: Action parameter accepted in an action definition that selects rows of one entity type. The caller names the rows by primary key (one value, or a list of up to 200 when cardinality is many), or the parameter selects them with its set definition and the call sends no value. The rows are read again when the action runs, and derive adds computed columns to each row. Response: Action parameter returned in an action definition that selects rows of one entity type. The caller names the rows by primary key (one value, or a list of up to 200 when cardinality is many), or the parameter selects them with its set definition and the call sends no value. The rows are read again when the action runs, and derive adds computed columns to each row.

requiredRequired (boolean)

False lets the call omit it — an empty many is [], an empty one is null, a value takes its schema default

기본값: true
kindKind (string)필수
상수 값: entity
entity_idEntity Id (string)필수

EntityType.id the rows belong to

Possible values: non-empty

cardinalityCardinality (string)

Possible values: [one, many]

기본값: one
derive object

walker derive spec — derived columns joining the row

하나 이상(anyOf)
object
set object

A walker definition (from + ops[] — D2) whose TERMINAL type is entity_id; its rows are the parameter's rows and the call sends no value. Data positions may read {{context.parameters.<value parameter>}}.

하나 이상(anyOf)
object

Ontology set definition: from and optional ops, without a terminal. Its shape is the definition part of the Execute Ontology Request body (POST /api/v1/ontologies/execute).

EntityParameter
{
"required": true,
"kind": "entity",
"entity_id": "string",
"cardinality": "one",
"derive": {},
"set": {}
}