Skip to content

Schema components

A schema stores meta data, form definitions, view definitions, and agent definitions. All are expressed in JSON, based as far as possible on OpenAPI specification.

Form definitions

Form definitions relate to Documents that have a Form item with the given value, not the Form design element with the given name. The Admin UI uses fields listed in Form design elements, so it's convenient to create form definitions. At runtime, no Form design element is used by the REST API.

Tutorials

References

View definitions

A view definition configures view visibility and the selection and naming of the view columns. It's an array of entries describing the name or alias, if any, and UNID of the view design element. Views show all columns contained.

Tutorials

How-to guide

References

Agent definitions

Suitable agents can be called from the Domino REST API.

Note

The API doesn't check if the agent is suitable for being called individually. It's the developer's responsibility to ensure this.

Tutorials

How-to guide

References

Meta data

Info

Section under development