Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Sample shape for DataFieldPercent.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "fieldType": "example",
  "minimum": 0,
  "maximum": 0,
  "defaultValue": "example",
  "name": "Example name",
  "prompt": "example",
  "description": "Example description.",
  "isCore": false,
  "isFeature": false,
  "featureName": "example",
  "placement": [
    "<field-placement>"
  ],
  "usage": [
    "<field-usage>"
  ],
  "listEditable": false
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
fieldTypestring • nullableOptional
minimumintegerOptional
maximumintegerOptional
defaultValuestringOptional
namestringOptional
promptstringOptional
descriptionstringOptional
isCorebooleanOptional
isFeaturebooleanOptional
featureNamestringOptional
placementarray<FieldPlacement>Optional
usagearray<FieldUsage>Optional
listEditablebooleanOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/field/percent
  • PUT /api/field/percent