Skip to content

Service reference

Every key of a Service product file, the Verbs and Events of a Service Order, and the publish check, for lookup.

A Service is a product file with $type: [Service]. These tables list what each key holds and every Verb a Service Order moves by.

Definition

KeyTypeHoldsRequiredStatus
$typelistOne or more of App, API, Agent, Dataset, Servicerequiredlive
nounsNoun namesThe Nouns it exposes; a Dataset holds Things of exactly onelive
verbsVerb idsThe Verbs a Customer may calllive
interfaceslistThe Interfaces it ships on; every kind by defaultlive
workNoun nameThe work Noun it holds from intake until the Customer acceptsrequiredplanned
intakelist of { name, type, measure, required }What the buyer sends before work startsrequiredbeta
coveragelist of sentencesWhat it delivers, for which inputs, stated before any chargerequiredbeta
cadenceonce, recurring or standingOnce per Order, on a period, or continuous and judged by rate termsrequiredbeta
stepslist of stepsEach a Verb with its Function, doer, checker, assurance and legal floorrequiredbeta
supplylist of { role, source }Who does the work, each owned, wrapped or recruitedbeta
contractOutcome Contract termsThe default promise; an Offer may tighten it, never loosen itrequiredbeta
ofRecordstringThe partner of record when a step needs a licensed practicebeta

The product file convention shows the keys in a working file.

The contract key takes the Outcome Contract's terms: done, statement, accept, window, silence, revisions, deadline, atRisk, clockExcludes, rateTerms, creditCap, remedy, warranty, earns and liabilityMultiple. Each step takes id, verb, function, doer, checker, provides, floor, reason, credential, timeout, escalatesTo, after and rechecksAll.

Verbs

VerbWhat it doesEvent
Quote.requestAsks for terms with a briefQuote.requested
Quote.acceptTurns a sent Quote into an Order, payment authorizedQuote.accepted
Order.placeBuys a fixed-scope Offer at its list PriceOrder.placed
Order.startChecks the inputs against the brief and starts the deadlineOrder.started
Order.deliverRuns every checker, then hands over the linesOrder.delivered
Order.confirmAccepts lines; runs on its own when a window closes in silenceOrder.confirmed
Order.reviseSends lines back for one counted revisionOrder.revised
Order.disputeContests lines and starts the remedyOrder.disputed
Order.refundReturns all or part of the paymentOrder.refunded

Offer.publish refuses a Service Offer whose remedy or basis needs stronger checks than the Service's steps provide, with contract-unsupported.

Capabilities without a Verb

CapabilityWhat it addsProposed Verbs
Service capacityOpen, pause, set capacity and close a ServiceService.open, Service.pause, Service.setCapacity, Service.close
A work ThingThe item a Service holds from intake to accepted, apart from the OrderStart, deliver, accept, revise, dispute and close on the work Thing

A capability with status planned has no Verb, so no guide offers it and no agent promises it.