Skip to content

GET /field

Fetch Field

GET
/field

Fetch custom field definitions, optionally filtered by name or key.

Returns all CustomField documents sorted alphabetically by name.
Pass name to filter by exact field name, or key to fetch a single
field by its ArangoDB _key. Both filters can be combined.

Emits: (direct query — no event class)

Required scope: quality:form:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

name
key

Responses

Successful Response

application/json
JSON
[
]

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.