Get Behavioural Model
get_behavioural_modelRead a model's behavioural model: what the system does, as elements, actions and zones taken from its description. Read-only.
Instructions
Read a model's behavioural model: what the system does, as elements, actions and zones taken from its description. Read-only.
status: none (extract_behavioural_model gives it one),
needs_answers, extracted, confirmed, stale (the
description changed since) or extracting. questions are the open
ones, answered with answer_behavioural_questions; one carrying
structured takes a structured answer, one with awaiting_fix was
answered. pending_answers: collected, not extracted. ir_hash is
what confirm_behavioural_model names. waiting_on:
extraction, acceptance, answers, generation or
nothing. extraction.job: the extraction running in the
background (null when none), its progress (pass, calls done and
expected, estimated finish); extraction.dropped_elements: what it
could not keep, with the sentence to answer. generation_ready: call
generate_from_behavioural_model.
view="status" serves no IR and no questions: use it to follow an
extraction. view="questions": that and the open questions from
offset, limit of them (default 50, at most 200), with total
and next_offset. wait_seconds (0 to 50) waits for the job's
state, pass or calls completed to change, sending progress ("call 3 of
5: actions") meanwhile; at once when no job runs. Read again after
poll_after_seconds.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | ``full`` (default), ``status`` or ``questions``. | full |
| limit | No | ``questions`` view only. | |
| offset | No | ``questions`` view only. | |
| model_id | Yes | ID of the threat model. | |
| wait_seconds | No | 0 (default) answers at once. | |
| server_version | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||