Documentation

Global

Type Definitions

"AutoNumber" | "Binary" | "Boolean" | "DateTime" | "Decimal" | "Enum" | "EnumSet" | "HashString" | "Integer" | "Long" | "ObjectReference" | "ObjectReferenceSet" | "String"

# AttributeType

Represents the type of attribute.

undefined | string | boolean | Date | BigJS | GUID | Array

# AttributeValue

Represents the value of an attribute.

string

# Entity

Name of the Entity

Example
MyFirstModule.Entity
string

# GUID

Represents a GUID of a MxObject

Example
"12345678"
FunctionQueryFilter | ValueQueryFilter | AttributeQueryFilter | AssociationQueryFilter | RelatedEntityQueryFilter

# QueryFilter

A query to filter returned records in the local database. Only supported in offline apps.

Example
const complexFilter = {
  type: "function",
  name: "and",
  parameters: [
    {
      type: "function",
      name: "=",
      parameters: [
        { type: "attribute", attribute: "Name", attributeType: "String" },
        { type: "value", value: "John" }
      ]
    },
    {
      type: "function",
      name: "or",
      parameters: [
        {
          type: "function",
          name: "contains",
          parameters: [
            { type: "attribute", attribute: "Employer", attributeType: "String" },
            { type: "value", value: "Mendix" }
          ]
        },
        {
          type: "function",
          name: "not",
          parameters: [
            {
              type: "function",
              name: "=",
              parameters: [
                { type: "attribute", attribute: "Age", attributeType: "Integer" },
                { type: "value", value: 30 }
              ]
            },
            {
              type: "function",
              name: "and",
              parameters: [
                {
                  type: "function",
                  name: "starts-with",
                  parameters: [
                    { type: "attribute", attribute: "FirstName", attributeType: "String" },
                    { type: "value", value: "A" }
                  ]
                },
                {
                  type: "function",
                  name: "ends-with",
                  parameters: [
                    { type: "attribute", attribute: "LastName", attributeType: "String" },
                    { type: "value", value: "son" }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
};

Type Definitions