Skip to content

PATCH /issue-type/

Update Issue Type

PATCH
/issue-type/{issue_type_key}

Partially update an existing issue type.

Applies the supplied fields to the IssueType document identified by
issue_type_key. Unset fields are left unchanged (keep_none=False).

Emits: (direct transaction — no event class)

Required scope: collaboration:issue-type:write

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

issue_type_key*
Type
string
Required

Request Body

application/json
JSON
{
  
"_key": "issuetype_001",
  
"code": "INSP-FAIL",
  
"name": "Inspection Failure",
  
"active": true,
  
"description": "Used when an inspection step fails due to dimensional non-conformance.",
  
"icon": "warning",
  
"form_template": [
  
  
{
  
  
  
"_key": "ffd-001",
  
  
  
"custom_field_key": "cf-001",
  
  
  
"multiple": false,
  
  
  
"label": "Colour Code",
  
  
  
"hint": "Verify against approved colour chart",
  
  
  
"default": "pass",
  
  
  
"mandatory": false,
  
  
  
"hidden": false
  
  
}
  
],
  
"critical": false
}

Responses

Successful Response

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

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.