Skip to content

PUT /field/

Replace Field Metadata

PUT
/field/{field_key}

Replace a custom field definition.

Performs a full replace of the CustomField document identified by
field_key. Validates that the resulting slug does not collide with any
other existing field (self-collision is allowed). Returns HTTP 409 on
conflict.

The payload must include _key in field_data.

Emits: (direct transaction — no event class)

Required scope: quality:form:update

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

Path Parameters

field_key*
Type
string
Required

Request Body

application/json
JSON
{
  
"_id": "string",
  
"_key": "string",
  
"_rev": "string",
  
"type": "text",
  
"name": "Surface Colour",
  
"default_label": "Surface Colour",
  
"default_hint": "Select the RAL colour code applied to this part"
}

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.