NEneotimo
Core/CustomFields

Lists the custom field definitions applicable to an entity of a model.

Changed on

Returns the deduplicated, ordered union of the model-wide definitions and the owner-scoped definitions matching the entity's scope owners — the same resolution the UI performs when it renders the entity's form. Pass one scope query parameter per owner the entity is attached to, in the compact form ownerType:ownerId[:depth] (e.g. ?scope=EquipmentCategory:42). No scope parameter: only model-wide definitions are returned. Labels (designation) are resolved for the request culture.

get/api/v1/core/custom-fields/{modelName}/definitions

Request

  • Base URL
    https://api.neotimo.com
  • Auth
    HTTP bearer and API key in header X-Api-Key

Path parameters

modelNamestring required

The carrier model name (e.g. DefaultModel).

Query parameters

scopestring[]

Scope owners of the entity, each as ownerType:ownerId[:depth].

Response

The applicable definitions

Changes

  • d134f2cbfaf5Revision changes
    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

  • 2ecf51b1543eRevision changes
    • info

      endpoint added