Kordon icon

Kordon

Interact with the Kordon API

Custom Field → Create

AI-generated

Summary

Create a new custom field tied to a specific resource type within the Kordon system.

Inputs

  • Attribute Of (required) — Select the resource type (e.g., Asset, Requirement, Vendor) that this custom field will be associated with.
  • Label (required) — Define the display name of the custom field as shown to users in the UI.
  • Key (required) — Set the internal field name (lowercase with underscores) used as the key when assigning values to this custom field on resources.
  • Type (required) — Select the data type of the custom field; currently only 'String' is supported.
  • Description — Optionally provide a description explaining the purpose of the custom field.
  • Visible in UI — Optionally specify whether the custom field is shown in the resource's detail view in the user interface.

Output shape

a single record representing the newly created custom field's data including its ID, label, key, associated resource type, type, and optionally description and UI visibility flag

The operation returns the created custom field object as confirmation. Inputs are validated with required fields; additional optional parameters can be included via Additional Fields. Request options such as batching, proxy, and timeout may affect how the request is executed but do not change output shape.

Examples

Example 1: Create a string custom field labeled "Compliance Status" for Requirements with a key of "compliance_status", visible in the UI and described as "Track the compliance status of requirements".

Set Attribute Of to Requirement, Label to Compliance Status, Key to compliance_status, Type to String, Description to the given text, and Visible in UI to true.

Links

Discussion