Schemas

Advanced Application Key Query

Schema for advanced application key queries

Advanced Application Key Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedApplicationKeyQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedApplicationKeyQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedApplicationKeyQuery"
      },
      "maxItems": 100
    },
    "id": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "creationDate": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "lastUpdated": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "status": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "deviceIds": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "deviceTags": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "$tagKey": {
                  "type": "string",
                  "maxLength": 255
                },
                "$tagValue": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "additionalProperties": false,
              "minProperties": 1
            },
            {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "additionalProperties": false
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "$tagKey": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "$tagValue": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false,
                  "minProperties": 1
                },
                {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "$tagKey": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "$tagValue": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false,
                  "minProperties": 1
                },
                {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    },
    "key": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "description": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "filterType": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "pubTopics": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "subTopics": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    }
  }
}

Advanced Application Key Query Example

{
  "$nor": [
    {
      "id": "575ec8687ae143cd83dc4a97"
    },
    {
      "description": "my access key"
    },
    {
      "lastUpdated": {
        "$lt": 1612189931000
      }
    }
  ]
}

Advanced Device Query

Schema for advanced device queries

Advanced Device Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedDeviceQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedDeviceQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedDeviceQuery"
      },
      "maxItems": 100
    },
    "id": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "creationDate": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "lastUpdated": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "name": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "deviceClass": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "gatewayId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "parentId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "ancestorId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "attributeName": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "experienceUserId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "experienceGroupId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "tags": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "$tagKey": {
                  "type": "string",
                  "maxLength": 255
                },
                "$tagValue": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "additionalProperties": false,
              "minProperties": 1
            },
            {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "additionalProperties": false
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "$tagKey": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "$tagValue": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false,
                  "minProperties": 1
                },
                {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "$tagKey": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "$tagValue": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false,
                  "minProperties": 1
                },
                {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    },
    "disconnectedAt": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "connectedAt": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "connectionStatus": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Advanced Device Query Example

{
  "$or": [
    {
      "name": {
        "$ne": "myValue"
      }
    },
    {
      "parentId": "575ec8687ae143cd83dc4a97"
    }
  ]
}

Advanced Event Query

Schema for advanced event queries

Advanced Event Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedEventQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedEventQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedEventQuery"
      },
      "maxItems": 100
    },
    "id": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "creationDate": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "lastUpdated": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "sourceId": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "sourceType": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "level": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "state": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "subject": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "deviceId": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "experienceUserId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "experienceGroupId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "eventTags": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "$tagKey": {
                  "type": "string",
                  "maxLength": 255
                },
                "$tagValue": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "additionalProperties": false,
              "minProperties": 1
            },
            {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "additionalProperties": false
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "$tagKey": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "$tagValue": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false,
                  "minProperties": 1
                },
                {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "$tagKey": {
                      "type": "string",
                      "maxLength": 255
                    },
                    "$tagValue": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false,
                  "minProperties": 1
                },
                {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}": {
                      "type": "string",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Advanced Event Query Example

{
  "$or": [
    {
      "level": {
        "$ne": "myValue"
      }
    },
    {
      "level": 5
    }
  ]
}

Advanced Workflow By Version Query

Schema for advanced workflow queries

Advanced Workflow By Version Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowByVersionQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowByVersionQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowByVersionQuery"
      },
      "maxItems": 100
    },
    "name": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "id": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "creationDate": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "lastUpdated": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "flowClass": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "enabled": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "flowId": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    }
  },
  "additionalProperties": false
}

Advanced Workflow By Version Query Example

{
  "flowId": "000000000000000000000000"
}

Advanced Workflow Query

Schema for advanced workflow queries

Advanced Workflow Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowQuery"
      },
      "maxItems": 100
    },
    "name": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "id": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "creationDate": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "lastUpdated": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "flowClass": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "enabled": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "defaultVersion": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "triggers": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "maxLength": 255
            },
            "key": {
              "type": "string",
              "pattern": "^[0-9a-zA-Z_-]{1,255}$"
            },
            "config": {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}$": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null"
                  ],
                  "maxLength": 1024
                }
              }
            }
          },
          "required": [
            "type"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "key": {
                  "type": "string",
                  "pattern": "^[0-9a-zA-Z_-]{1,255}$"
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "key": {
                  "type": "string",
                  "pattern": "^[0-9a-zA-Z_-]{1,255}$"
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    },
    "nodes": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "maxLength": 255
            },
            "config": {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}$": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null"
                  ],
                  "maxLength": 1024
                }
              }
            }
          },
          "required": [
            "type"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Advanced Workflow Query Example

{
  "$or": [
    {
      "name": {
        "$ne": "flowie"
      }
    },
    {
      "enabled": false
    }
  ]
}

Advanced Workflow Version Query

Schema for advanced workflow queries

Advanced Workflow Version Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowVersionQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowVersionQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedFlowVersionQuery"
      },
      "maxItems": 100
    },
    "name": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "id": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "string",
              "pattern": "^[A-Fa-f\\d]{24}$"
            },
            {
              "type": "null"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$ne": {
              "oneOf": [
                {
                  "type": "string",
                  "pattern": "^[A-Fa-f\\d]{24}$"
                },
                {
                  "type": "null"
                }
              ]
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": "string",
                "pattern": "^[A-Fa-f\\d]{24}$"
              }
            }
          },
          "additionalProperties": false,
          "minProperties": 1,
          "maxProperties": 1
        }
      ]
    },
    "creationDate": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "lastUpdated": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "flowClass": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "enabled": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "version": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "triggers": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "maxLength": 255
            },
            "key": {
              "type": "string",
              "pattern": "^[0-9a-zA-Z_-]{1,255}$"
            },
            "config": {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}$": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null"
                  ],
                  "maxLength": 1024
                }
              }
            }
          },
          "required": [
            "type"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "key": {
                  "type": "string",
                  "pattern": "^[0-9a-zA-Z_-]{1,255}$"
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "key": {
                  "type": "string",
                  "pattern": "^[0-9a-zA-Z_-]{1,255}$"
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    },
    "nodes": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "maxLength": 255
            },
            "config": {
              "type": "object",
              "patternProperties": {
                "^[0-9a-zA-Z_-]{1,255}$": {
                  "type": [
                    "string",
                    "number",
                    "boolean",
                    "null"
                  ],
                  "maxLength": 1024
                }
              }
            }
          },
          "required": [
            "type"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$eq"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "$ne": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "maxLength": 255
                },
                "config": {
                  "type": "object",
                  "patternProperties": {
                    "^[0-9a-zA-Z_-]{1,255}$": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "maxLength": 1024
                    }
                  }
                }
              },
              "required": [
                "type"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "$ne"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Advanced Workflow Version Query Example

{
  "version": "theVersion"
}

Advanced Query

Schema for advanced filters and queries

Advanced Query Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$and": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedQuery"
      },
      "maxItems": 100
    },
    "$or": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedQuery"
      },
      "maxItems": 100
    },
    "$nor": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/advancedQuery"
      },
      "maxItems": 100
    }
  },
  "patternProperties": {
    "^[0-9a-zA-Z_-]{1,255}$": {
      "oneOf": [
        {
          "type": [
            "string",
            "number",
            "boolean",
            "null"
          ]
        },
        {
          "type": "object",
          "properties": {
            "$eq": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$ne": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lt": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$gte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$lte": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            },
            "$startsWith": {
              "type": "string",
              "minLength": 1
            },
            "$endsWith": {
              "type": "string",
              "minLength": 1
            },
            "$contains": {
              "type": "string",
              "minLength": 1
            },
            "$ci": {
              "type": "boolean"
            },
            "$in": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "$nin": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            }
          },
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Advanced Query Example

{
  "$or": [
    {
      "level": {
        "$ne": "myValue"
      }
    },
    {
      "level": 5
    }
  ]
}

API Token

Schema for a single API Token

API Token Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "apiTokenId": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "ownerId": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "application"
      ]
    },
    "creatorId": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "creatorType": {
      "type": "string",
      "enum": [
        "apiToken",
        "user",
        "flow"
      ]
    },
    "creatorName": {
      "type": "string",
      "maxLength": 1024
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "maxLength": 32767
    },
    "creationDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time"
    },
    "expirationDate": {
      "type": "string",
      "format": "date-time"
    },
    "scope": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "token": {
      "type": "string",
      "minLength": 1
    }
  }
}

API Token Example

{
  "id": "575ec7417ae143cd83dc4a95",
  "apiTokenId": "575ec7417ae143cd83dc4a95",
  "creatorId": "575ed70c7ae143cd83dc4aa9",
  "creatorType": "user",
  "ownerId": "575ec8687ae143cd83dc4a97",
  "ownerType": "application",
  "name": "My API Token",
  "creationDate": "2016-06-13T04:00:00.000Z",
  "lastUpdated": "2016-06-13T04:00:00.000Z",
  "expirationDate": "2017-06-13T04:00:00.000Z",
  "scope": [
    "all.Application"
  ],
  "status": "active",
  "token": "the_actual_token_string"
}

API Token Patch

Schema for the body of an API Token modification request

API Token Patch Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "maxLength": 32767
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "inactive"
      ]
    }
  },
  "additionalProperties": false
}

API Token Patch Example

{
  "name": "My Updated API Token",
  "status": "inactive"
}

API Tokens

Schema for a collection of API Tokens

API Tokens Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "title": "API Token",
        "description": "Schema for a single API Token",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^[A-Fa-f\\d]{24}$"
          },
          "apiTokenId": {
            "type": "string",
            "pattern": "^[A-Fa-f\\d]{24}$"
          },
          "ownerId": {
            "type": "string",
            "pattern": "^[A-Fa-f\\d]{24}$"
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "application"
            ]
          },
          "creatorId": {
            "type": "string",
            "pattern": "^[A-Fa-f\\d]{24}$"
          },
          "creatorType": {
            "type": "string",
            "enum": [
              "apiToken",
              "user",
              "flow"
            ]
          },
          "creatorName": {
            "type": "string",
            "maxLength": 1024
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": "string",
            "maxLength": 32767
          },
          "creationDate": {
            "type": "string",
            "format": "date-time"
          },
          "lastUpdated": {
            "type": "string",
            "format": "date-time"
          },
          "expirationDate": {
            "type": "string",
            "format": "date-time"
          },
          "scope": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 1024
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive"
            ]
          },
          "token": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "totalCount": {
      "type": "integer"
    },
    "perPage": {
      "type": "integer"
    },
    "page": {
      "type": "integer"
    },
    "filter": {
      "type": "string"
    },
    "filterField": {
      "type": "string"
    },
    "sortField": {
      "type": "string"
    },
    "sortDirection": {
      "type": "string",
      "enum": [
        "asc",
        "desc",
        "ASC",
        "DESC",
        ""
      ]
    },
    "ownerId": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "application"
      ]
    }
  }
}

API Tokens Example

{
  "items": [
    {
      "id": "575ec7417ae143cd83dc4a95",
      "apiTokenId": "575ec7417ae143cd83dc4a95",
      "creatorId": "575ed70c7ae143cd83dc4aa9",
      "creatorType": "user",
      "ownerId": "575ec8687ae143cd83dc4a97",
      "ownerType": "application",
      "name": "My API Token",
      "creationDate": "2016-06-13T04:00:00.000Z",
      "lastUpdated": "2016-06-13T04:00:00.000Z",
      "expirationDate": "2017-06-13T04:00:00.000Z",
      "scope": [
        "all.Application"
      ],
      "status": "active",
      "token": "the_actual_token_string"
    }
  ],
  "count": 1,
  "totalCount": 4,
  "perPage": 1,
  "page": 0,
  "sortField": "name",
  "sortDirection": "asc",
  "ownerId": "575ec8687ae143cd83dc4a97",
  "ownerType": "application"
}

Application

Schema for a single Application

Application Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "applicationId": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "creationDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time"
    },
    "appliedTemplateIds": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Fa-f\\d]{24}$"
      },
      "maxItems": 1000
    },
    "ownerId": {
      "type": "string",
      "pattern": "^[A-Fa-f\\d]{24}$"
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "user",
        "organization"
      ]
    },
    "organizationName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "organizationIconColor": {
      "type": "string",
      "maxLength": 64
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "maxLength": 1024
    },
    "endpointSlug": {
      "type": "string",
      "minLength": 4,
      "maxLength": 63,
      "pattern": "^[0-9a-z-]*$"
    },
    "expUserTokenCutoff": {
      "type": "string",
      "format": "date-time"
    },
    "endpointDefaultCors": {
      "type": "boolean"
    },
    "globals": {
      "type": "array",
      "maxItems": 100,
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
          },
          "json": {
            "type": "string",
            "minLength": 1,
            "maxLength": 32767
          },
          "cloudOnly": {
            "type": "boolean",
            "default": false
          },
          "description": {
            "type": "string",
            "maxLength": 1024
          }
        },
        "additionalProperties": false,
        "required": [
          "key",
          "json"
        ]
      }
    },
    "blobUrlTTL": {
      "type": "number",
      "minimum": 3600,
      "maximum": 604800
    },
    "summary": {
      "type": "object",
      "properties": {
        "apiTokenCount": {
          "type": "number"
        },
        "dataTableCount": {
          "type": "number"
        },
        "deviceCount": {
          "type": "number"
        },
        "deviceRecipeCount": {
          "type": "number"
        },
        "eventCount": {
          "type": "number"
        },
        "experienceDomainCount": {
          "type": "number"
        },
        "experienceEndpointCount": {
          "type": "number"
        },
        "experienceGroupCount": {
          "type": "number"
        },
        "experienceSlugCount": {
          "type": "number"
        },
        "experienceUserCount": {
          "type": "number"
        },
        "experienceVersionCount": {
          "type": "number"
        },
        "experienceViewCount": {
          "type": "number"
        },
        "fileCount": {
          "type": "number"
        },
        "flowCount": {
          "type": "number"
        },
        "integrationCount": {
          "type": "number"
        },
        "keyCount": {
          "type": "number"
        },
        "storageStats": {
          "type": "object",
          "properties": {
            "count": {
              "type": "number"
            },
            "size": {
              "type": "number"
            }
          }
        },
        "webhookCount": {
          "type": "number"
        }
      }
    },
    "ftueTracking": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "pattern": "^[0-9a-zA-Z_-]{1,255}$"
          },
          "version": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "skipped",
              "completed"
            ]
          }
        },
        "required": [
          "name",
          "version",
          "status"
        ],
        "additionalProperties": false
      },
      "maxItems": 100
    },
    "archiveConfig": {
      "type": "object",
      "properties": {
        "directory": {
          "type": "string",
          "max": 255
        },
        "mode": {
          "type": "string",
          "enum": [
            "all",
            "whitelist",
            "blacklist"
          ]
        },
        "deviceIds": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[A-Fa-f\\d]{24}$"
          },
          "maxItems": 1000
        },
        "deviceTags": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string",
                "pattern": "^[0-9a-zA-Z_-]{1,255}$"
              },
              "value": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              }
            },
            "additionalProperties": false
          },
          "maxItems": 100
        },
        "includeDevices": {
          "type": "boolean",
          "default": true
        },
        "includeEvents": {
          "type": "boolean",
          "default": false
        },
        "includeDataTables": {
          "type": "boolean",
          "default": false
        },
        "dataTablesMode": {
          "type":