Skip to content

Interface: Pin

@kortexya/reasoninglayer


@kortexya/reasoninglayer / Scheduling / Pin

Interface: Pin

Defined in: src/types/scheduling.ts:106

A pre-assigned (agent, day, shift) triple. The engine treats the pin as confirmed-true and reduces the slot’s remaining demand.

When the agent has multiple roles that each match a role minimum at the target slot, the caller MUST set Pin.role to disambiguate. Otherwise the backend returns HTTP 400 with an “ambiguous pin role” error listing the candidate roles.

Role semantics:

  • undefined — no role specified. Valid only when the agent has at most one role matching this slot’s role minimums.
  • "any" (see ANY_ROLE) — route through the unroled pool; no role minimum is decremented.
  • "<role>" — force the pin to cover this role. Must be a role the agent possesses (HTTP 400 otherwise).

Properties

agentId

agentId: string

Defined in: src/types/scheduling.ts:107


day

day: number

Defined in: src/types/scheduling.ts:108


role?

optional role: string

Defined in: src/types/scheduling.ts:111

Role the pin covers. See docs above for the cases.


shift

shift: number

Defined in: src/types/scheduling.ts:109