---
id: TST-PFM-MTD-086
title: console forms api
kind: api-lifecycle
product_area: platform
module: metadata
revision: 1
status: draft
source_sha:
  services-platform: ad3f6a6582843008ed0f5a17b131878d15829af1
repository: services-platform
files:
  - modules/layouts/tests/e2e/console-forms-api.e2e.spec.js
implements: []
environment: local
implementation_state: implemented
latest_result: not-run
latest_run_at: null
latest_run_ref: null
conformance: not-verified
estimated_minutes: 5
isolation: >-
  Prepared integration database and the suite fixture records; fixture teardown restores or removes its own
  rows.
evidence:
  - 'services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js'
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#serves the six operations of the
    resource
  - 'services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 without a context'
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#names the service and says it is
    well
  - 'services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 for a valid body'
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers the record with the
    fields it was given and the server stamps
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers the layout document
    exactly as it was sent
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#generates an id when the body
    sends none
  - 'services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#keeps the id the body sends'
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a body with no
    name
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a layout that is
    not an object
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a layout larger
    than the stated maximum
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a purpose this
    build does not register, naming it
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a body with a
    field the contract does not define
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 403 to a caller who may
    read contacts but not administer their layouts
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 403 to an administrator
    of another purpose’s layouts
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#names the keys the caller would
    need when it refuses
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 401 to an anonymous
    caller
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 403 for a tenant the
    context was not signed for
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#creates a definition of the
    other purpose for the administrator of that purpose
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 and the record to
    the administrator of its purpose
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 to a caller who may
    merely read the record the layout is for
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404 for a definition of
    a purpose the caller may not read, rather than confirming it exists
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404 to a caller holding
    no purpose key at all
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404 for an id the tenant
    does not hold
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers only the fields ?fields=
    names
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 401 to an anonymous
    caller
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers the definitions under
    the resource’s own plural, in name order
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#leaves out the purposes the
    caller may not read, so a list never discloses another
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers both purposes to a
    caller who may read both
  - 'services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#narrows the list to ?purpose='
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers an empty list for a
    purpose the caller may not read
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers an empty list to a
    caller holding no purpose key at all
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers one page and the cursor
    of the next when ?limit= is smaller than the list
  - 'services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#continues after ?cursor='
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a ?limit=
    outside the bounds
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a ?cursor= it
    did not issue
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers only the fields ?fields=
    names, in every record of the page
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 401 to an anonymous
    caller
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 and the replaced
    record at the next version
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#accepts the record exactly as a
    read answered it, which is the round trip a console makes
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 409 for the version the
    caller did not read
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a body that
    names another purpose
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a body whose id
    is not the path’s
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 403 to a caller who may
    read the definition but not administer it
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404, not 403, to a
    caller who may not even read it
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404 for an id the tenant
    does not hold
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 and the patched
    record
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#replaces the layout document a
    directive names
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a directive that
    would change the purpose
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 400 for a directive that
    empties the name
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 403 to a caller who may
    read the definition but not administer it
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404 for an id the tenant
    does not hold
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 and the definition
    is then unreadable
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 403 to a caller who may
    read the definition but not administer it
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404, not 403, to a
    caller who may not even read it
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 409 while something
    still assigns the definition, naming the referring row
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 200 once the assignment
    is gone
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#answers 404 for an id the tenant
    does not hold
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#is refused the create, which the
    same body being created by a purpose administrator is the premise for
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#is refused the create of the
    other purpose too, because the wildcard is not what this route answers
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#is refused the read of a
    definition, where the other purpose’s administrator is merely told there is none
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#is unreachable through the path
    of the tenant the caller was signed for
  - >-
    services-platform:modules/layouts/tests/e2e/console-forms-api.e2e.spec.js#is refused as a tenant boundary
    when the caller names that tenant’s path
fixture_imports:
  - chai
  - drizzle-orm
  - ../../../../aws/api/platform-api-handler
  - ../../db/layout-assignments.table
  - ../../../../db/config
  - '@rhythmsoftware/macroservice-testing/integration-database'
  - '@rhythmsoftware/macroservice-testing/signed-context'
  - '@rhythmsoftware/macroservice-testing/stage'
  - ./route-callers
  - ../../aws/api/console-forms.routes
  - ../../aws/api/layouts.routes
  - '@rhythmsoftware/macroservice-execution/tenant-time-zones'
  - ../../../tenants/services/persistence/tenants
  - ../integration/support
test_doubles: []
limitations: []
unmatched_specification: FND-PFM-MTD-083
binding_assertions: []
---

# Console forms api

## Verification Boundary

This API suite checks reusable record presentations within the local test harness. The registered file and pinned revision define its boundary.

## What This Suite Proves

The suite contains executable checks for this module, but no matching detailed scenario is established in this back-fill. The executable coverage finding records that mapping gap. Assertions are evidence of implemented checks; no execution result is claimed.

## What It Does Not Prove

The register does not establish a current passing run or full specification conformance. Behavior outside the suite’s fixtures and assertions remains unverified.

## Real Dependencies and Test Doubles

The fixture uses PostgreSQL and the imported persistence or API code. The fixture imports identify the setup seams; this register makes no broader claim that dependencies are undoubled.

## Must Not Be Doubled

The operation under examination and its asserted stored outcomes must remain real within the declared harness. A fixture cannot replace the write, refusal or transactional effect that the bound scenario checks.
