Skip to content

Check an approved watch now

POST
/api/v1/realms/{realm}/watches/{watch}/check-now
curl --request POST \
--url http://localhost:11044/api/v1/realms/example/watches/example/check-now \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Runs as the signed-in owner and takes no body or query. DELIVERED means the host accepted the notification.

realm
required
string

Name of the captured realm in the signed-in owner’s world that declares the watch

watch
required
string

Name of one of that realm’s approved watches, which runs once now, as the owner, outside its schedule

OK

Media type*/*

What one owner-requested check of an approved Realm watch did. Answered by POST /realms/{realm}/watches/{watch}/check-now.

object
delivered
required

Notifications the host accepted in this run; they stay counted when later work fails or is refused

integer format: int32
judged
required

New items this run put in front of the judge, not counting items too big to judge

integer format: int32
outcome
required

BASELINED (a first run: it recorded what the lens shows and delivered nothing), DELIVERED (at least one approved item was delivered), NOTHING_NEW, FAILED (the run stopped short; see problem), REFUSED (no such approved watch, the owner’s authority did not hold, or the run failed unexpectedly) or ALREADY_RUNNING (another run of this watch was in progress, so this one did nothing)

string
problem

Why the run stopped short, such as LENS_FAILED, JUDGE_UNAVAILABLE or DELIVERY_FAILED; ITEM_TOO_BIG beside DELIVERED or NOTHING_NEW means one or more items were skipped as too big to judge. Null when nothing went wrong

string
watch
required

Name of the watch that was checked; empty when the realm or watch name in the path is not a valid name

string