Skip to main content

In your app

A controller answers a route on your app: it calls listForms() and returns the answer.

Add the controller

app/controllers/list_forms_controller.ts

Add the route

start/routes.ts

Call it

Terminal
With node ace serve running, it prints its answer as JSON.
One object, e.g. listForms({ page }); leave out the optional fields.
number | null | undefined
Optional. Leave it out and the site uses 1. Page number for pagination (1-based)
number | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).
AposMode | null | undefined
Optional. Leave it out and the site uses "published". published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. en (default: the site’s default locale).
boolean | null | undefined
Optional. Leave it out and the site uses false. true: each area’s widgets come back rendered as HTML (_rendered), beside their data.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.
A FormList. A page of Form documents. Read its properties (formList.results): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _form → form, _destination → destination).
readonly Form[]
Always sent. A list of Form. This page’s documents; empty past the last page.
number
Always sent. Pages in the whole list (0 when it is empty).
number
Always sent. This page, from 1.
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.
400
The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.
401
The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage, errorName, data.
403
The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.
404
Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.
500
The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). Read: siteMessage, errorName, data.
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.
setup
sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.
setup
The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with content:forms:read (or a master above it: content:forms:all, content:all, admin:all) reads the published documents; drafts (aposMode=draft) need content:forms:write (or a master above it). A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
  • Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
  • Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
  • Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.
  • Paging: one page per call. To walk them all, use listFormsAll() (see More examples): it asks for the next page as you iterate, and stops after page pages.

More examples

listFormsAll() takes listForms()’s arguments except page. listFormsPick() takes the same arguments except page, after the fields to answer: each row is the document’s id and those fields.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/forms_list_forms.spec.ts, then run your tests:
tests/unit/forms_list_forms.spec.ts
Terminal
Answer with your own values: fake forms.listForms with a sequence() of pages, each factories.FormList({...}), and walk listFormsAll().
tests/unit/forms_list_forms_answers.spec.ts
To fake listFormsAll(), answer forms.listForms (the walk calls it page by page): a sequence() of answers for several pages.

List a form’s locales

site.forms().getFormLocales()

Create a form

site.forms().createForm()

Get a form

site.forms().getForm()

Replace a form

site.forms().replaceForm()

Delete a form

site.forms().deleteForm()

Update a form

site.forms().updateForm()

GET /@apostrophecms/form

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.