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 DataConstraint.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "name": "Example name",
  "container": [
    "example"
  ],
  "sourceFieldId": "<source-field_id>",
  "sourceFieldDataId": "<source-field-data_id>",
  "targetFieldId": "<target-field_id>",
  "targetFieldDataId": [
    "<target-field-data_id>"
  ],
  "targetMode": "<constraint-target-type>"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequired
containerarray<string>Optional
sourceFieldIdstringRequired
sourceFieldDataIdstringRequired
targetFieldIdstringRequired
targetFieldDataIdarray<string>Required
targetModeConstraintTargetTypeOptional
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/constraint
  • PUT /api/constraint/{id}

​
Response body

  • GET /api/constraint/container/{containerId}
  • GET /api/constraint/{id}
  • GET /api/constraint

​
CLI

ekso constraint — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.