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",
        "user"
      ]
    },
    "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 Token Post

Schema for the body of an API Token creation request

API Token Post Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "maxLength": 32767
    },
    "expirationDate": {
      "type": "string",
      "format": "date-time"
    },
    "scope": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "oneOf": [
          {
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "all.Application",
                  "all.Application.read",
                  "all.Application.cli",
                  "all.Device",
                  "all.Device.read",
                  "application.*",
                  "applicationApiToken.*",
                  "applicationApiTokens.*",
                  "applicationCertificate.*",
                  "applicationCertificates.*",
                  "applicationCertificateAuthority.*",
                  "applicationCertificateAuthorities.*",
                  "applicationDashboards.*",
                  "applicationDashboard.*",
                  "applicationKey.*",
                  "applicationKeys.*",
                  "data.*",
                  "dataTable.*",
                  "dataTables.*",
                  "dataTableRow.*",
                  "dataTableRows.*",
                  "device.*",
                  "deviceRecipe.*",
                  "deviceRecipes.*",
                  "devices.*",
                  "edgeDeployment.*",
                  "edgeDeployments.*",
                  "event.*",
                  "events.*",
                  "experience.*",
                  "experienceDomain.*",
                  "experienceDomains.*",
                  "experienceEndpoint.*",
                  "experienceEndpoints.*",
                  "experienceGroup.*",
                  "experienceGroups.*",
                  "experienceSlug.*",
                  "experienceSlugs.*",
                  "experienceUser.*",
                  "experienceUsers.*",
                  "experienceVersion.*",
                  "experienceVersions.*",
                  "experienceView.*",
                  "experienceViews.*",
                  "integration.*",
                  "integrations.*",
                  "file.*",
                  "files.*",
                  "flow.*",
                  "flows.*",
                  "flowVersion.*",
                  "flowVersions.*",
                  "notebook.*",
                  "notebooks.*",
                  "webhook.*",
                  "webhooks.*",
                  "application.applyTemplate",
                  "application.archiveData",
                  "application.backfillArchiveData",
                  "application.clone",
                  "application.export",
                  "application.import",
                  "application.fullEventsArchive",
                  "application.fullDataTablesArchive",
                  "application.debug",
                  "application.delete",
                  "application.get",
                  "application.mqttPublishMessage",
                  "application.mqttSubscriptionStream",
                  "application.patch",
                  "application.payloadCounts",
                  "application.search",
                  "applicationApiToken.delete",
                  "applicationApiToken.get",
                  "applicationApiToken.patch",
                  "applicationApiTokens.get",
                  "applicationApiTokens.post",
                  "applicationCertificate.delete",
                  "applicationCertificate.get",
                  "applicationCertificate.patch",
                  "applicationCertificates.get",
                  "applicationCertificates.post",
                  "applicationCertificateAuthority.delete",
                  "applicationCertificateAuthority.get",
                  "applicationCertificateAuthority.patch",
                  "applicationCertificateAuthorities.get",
                  "applicationCertificateAuthorities.post",
                  "applicationDashboard.get",
                  "applicationDashboard.patch",
                  "applicationDashboard.delete",
                  "applicationDashboards.get",
                  "applicationDashboards.post",
                  "applicationKey.delete",
                  "applicationKey.get",
                  "applicationKey.patch",
                  "applicationKeys.get",
                  "applicationKeys.post",
                  "data.export",
                  "data.lastValueQuery",
                  "data.timeSeriesQuery",
                  "dataTable.addColumn",
                  "dataTable.delete",
                  "dataTable.get",
                  "dataTable.patch",
                  "dataTable.removeColumn",
                  "dataTableRow.delete",
                  "dataTableRow.get",
                  "dataTableRow.patch",
                  "dataTableRows.get",
                  "dataTableRows.post",
                  "dataTableRows.query",
                  "dataTableRows.export",
                  "dataTableRows.delete",
                  "dataTableRows.truncate",
                  "dataTables.get",
                  "dataTables.post",
                  "device.commandStream",
                  "device.debug",
                  "device.delete",
                  "device.export",
                  "device.get",
                  "device.getCommand",
                  "device.getCompositeState",
                  "device.getLogEntries",
                  "device.getState",
                  "device.patch",
                  "device.payloadCounts",
                  "device.removeData",
                  "device.sendCommand",
                  "device.sendState",
                  "device.setConnectionStatus",
                  "device.stateStream",
                  "deviceRecipe.bulkCreate",
                  "deviceRecipe.delete",
                  "deviceRecipe.get",
                  "deviceRecipe.patch",
                  "deviceRecipes.get",
                  "deviceRecipes.post",
                  "devices.attributeNames",
                  "devices.patch",
                  "devices.delete",
                  "devices.removeData",
                  "devices.detailedSummary",
                  "devices.export",
                  "devices.get",
                  "devices.payloadCounts",
                  "devices.post",
                  "devices.sendCommand",
                  "devices.tagKeys",
                  "devices.tagValues",
                  "edgeDeployment.get",
                  "edgeDeployments.get",
                  "edgeDeployments.release",
                  "edgeDeployments.remove",
                  "edgeDeployments.replace",
                  "event.delete",
                  "event.get",
                  "event.patch",
                  "events.delete",
                  "events.get",
                  "events.mostRecentBySeverity",
                  "events.patch",
                  "events.post",
                  "events.export",
                  "experience.delete",
                  "experience.bootstrap",
                  "experienceDomain.delete",
                  "experienceDomain.get",
                  "experienceDomain.patch",
                  "experienceDomains.get",
                  "experienceDomains.post",
                  "experienceEndpoint.delete",
                  "experienceEndpoint.get",
                  "experienceEndpoint.linkedResources",
                  "experienceEndpoint.patch",
                  "experienceEndpoints.get",
                  "experienceEndpoints.post",
                  "experienceEndpoints.stats",
                  "experienceGroup.delete",
                  "experienceGroup.get",
                  "experienceGroup.patch",
                  "experienceGroups.detailedSummary",
                  "experienceGroups.get",
                  "experienceGroups.post",
                  "experienceSlug.delete",
                  "experienceSlug.get",
                  "experienceSlug.patch",
                  "experienceSlugs.get",
                  "experienceSlugs.post",
                  "experienceUser.delete",
                  "experienceUser.get",
                  "experienceUser.patch",
                  "experienceUsers.detailedSummary",
                  "experienceUsers.get",
                  "experienceUsers.post",
                  "experienceVersion.delete",
                  "experienceVersion.get",
                  "experienceVersion.patch",
                  "experienceVersions.get",
                  "experienceVersions.post",
                  "experienceView.debug",
                  "experienceView.delete",
                  "experienceView.get",
                  "experienceView.linkedResources",
                  "experienceView.patch",
                  "experienceViews.debug",
                  "experienceViews.detailedSummary",
                  "experienceViews.get",
                  "experienceViews.post",
                  "file.get",
                  "file.patch",
                  "file.move",
                  "file.delete",
                  "file.upload",
                  "files.get",
                  "files.post",
                  "flow.clearStorageEntries",
                  "flow.debug",
                  "flow.delete",
                  "flow.errors",
                  "flow.get",
                  "flow.getStorageEntries",
                  "flow.log",
                  "flow.patch",
                  "flow.pressVirtualButton",
                  "flow.setStorageEntry",
                  "flow.getStorageEntriesMetadata",
                  "flow.stats",
                  "flows.get",
                  "flows.getByVersion",
                  "flows.import",
                  "flows.post",
                  "flowVersion.delete",
                  "flowVersion.errors",
                  "flowVersion.get",
                  "flowVersion.log",
                  "flowVersion.patch",
                  "flowVersion.stats",
                  "flowVersions.delete",
                  "flowVersions.get",
                  "flowVersions.post",
                  "integration.delete",
                  "integration.get",
                  "integration.patch",
                  "integrations.get",
                  "integrations.post",
                  "notebook.delete",
                  "notebook.execute",
                  "notebook.get",
                  "notebook.logs",
                  "notebook.patch",
                  "notebook.requestInputDataExport",
                  "notebook.upload",
                  "notebooks.get",
                  "notebooks.post",
                  "webhook.delete",
                  "webhook.get",
                  "webhook.patch",
                  "webhooks.get",
                  "webhooks.post"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "all.Organization",
                  "all.Organization.read",
                  "applications.*",
                  "auditLog.*",
                  "auditLogs.*",
                  "dashboard.*",
                  "dashboards.*",
                  "org.*",
                  "applications.get",
                  "applications.post",
                  "applications.import",
                  "applications.detailedSummary",
                  "auditLog.get",
                  "auditLogs.get",
                  "dashboard.patch",
                  "dashboard.delete",
                  "dashboard.sendReport",
                  "dashboards.get",
                  "dashboards.post",
                  "org.get",
                  "org.patch",
                  "org.delete",
                  "org.pendingInvites",
                  "org.inviteMember",
                  "org.revokeInvite",
                  "org.modifyMember",
                  "org.removeMember",
                  "org.payloadCounts",
                  "org.invoices",
                  "org.currentCard",
                  "org.chargeDetails",
                  "org.transferResources"
                ]
              }
            ]
          },
          {
            "type": "string",
            "enum": [
              "all.Instance",
              "all.Instance.read",
              "instance.*",
              "instance.get",
              "instance.patch",
              "instance.historicalSummaries",
              "instance.generateReport",
              "instanceOrg.*",
              "instanceOrg.get",
              "instanceOrg.patch",
              "instanceOrg.delete",
              "instanceOrgs.*",
              "instanceOrgs.get",
              "instanceOrgs.post",
              "instanceMember.*",
              "instanceMember.get",
              "instanceMember.patch",
              "instanceMember.delete",
              "instanceMembers.*",
              "instanceMembers.get",
              "instanceMembers.post",
              "instanceOrgMember.*",
              "instanceOrgMember.get",
              "instanceOrgMember.patch",
              "instanceOrgMember.delete",
              "instanceOrgMembers.*",
              "instanceOrgMembers.get",
              "instanceOrgMembers.post",
              "instanceOrgInvite.*",
              "instanceOrgInvite.get",
              "instanceOrgInvite.delete",
              "instanceOrgInvite.resendInvite",
              "instanceOrgInvites.*",
              "instanceOrgInvites.get",
              "instanceOrgInvites.post",
              "instanceApiTokens.*",
              "instanceApiTokens.get",
              "instanceApiTokens.post",
              "instanceApiToken.*",
              "instanceApiToken.get",
              "instanceApiToken.patch",
              "instanceApiToken.delete"
            ]
          },
          {
            "type": "string",
            "enum": [
              "all.User",
              "all.User.read",
              "all.User.cli",
              "userApiToken.*",
              "userApiToken.get",
              "userApiToken.patch",
              "userApiToken.delete",
              "userApiTokens.*",
              "userApiTokens.get",
              "userApiTokens.post",
              "applicationTemplate.*",
              "applicationTemplate.get",
              "applicationTemplates.*",
              "applicationTemplates.get",
              "applicationTemplates.getCategories",
              "applicationTemplates.getUniqueKeywords",
              "instances.*",
              "instances.get",
              "me.*",
              "me.get",
              "me.patch",
              "me.delete",
              "me.verifyEmail",
              "me.changePassword",
              "me.enableTwoFactorAuth",
              "me.disableTwoFactorAuth",
              "me.disconnectGithub",
              "me.connectGithub",
              "me.addRecentItem",
              "me.fetchRecentItems",
              "me.payloadCounts",
              "me.transferResources",
              "orgs.*",
              "orgs.get",
              "orgs.post"
            ]
          }
        ]
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "inactive"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

API Token Post Example