query.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "The query definition",
  "description": "The query definition",
  "QueryDetails": {
    "type": "object",
    "description": "The page with content.",
    "properties": {
      "content": {
        "description": "The rows of the page.",
        "type": "array",
        "items": {
          "$ref": "#/ResultsetContent"
        }
      },
      "totalRecords": {
        "description": "The total number of records in this resultset.",
        "type": "integer"
      },
      "queryId": {
        "description": "ID of the query",
        "type": "string",
        "format": "UUID"
      },
      "fqlQuery": {
        "description": "FQL query",
        "type": "string"
      },
      "entityTypeId": {
        "description": "ID of the entity type",
        "type": "string",
        "format": "UUID"
      },
      "fields": {
        "description": "Fields to be included in query results",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "status": {
        "description": "Status of the resultset",
        "type": "string",
        "enum": ["IN_PROGRESS", "SUCCESS", "FAILED", "CANCELLED"]
      },
      "failureReason": {
        "description": "Reason for query execution failure (if execution failed)",
        "type": "string"
      },
      "startDate": {
        "description": "Date and time when the query execution was started",
        "type": "string",
        "format": "date-time"
      },
      "endDate": {
        "description": "Date and time when the query execution was completed",
        "type": "string",
        "format": "date-time"
      },
      "crossTenant": {
        "description": "Indicates whether a query is cross-tenant",
        "type": "boolean",
        "default": false
      }
    },
    "required": [
      "entityTypeId",
      "status",
      "startDate",
      "queryId",
      "fqlQuery"
    ],
    "additionalProperties": false
  },
  "ResultsetContent": {
    "description": "The content row represented as a map.",
    "type": "object",
    "additionalProperties": {
      "type": "object"
    }
  },
  "QueryIdentifier": {
    "description": "The identifier of the query.",
    "type": "object",
    "properties": {
      "queryId": {
        "$ref": "common.json#/UUID"
      }
    },
    "additionalProperties": false
  },
  "SubmitQuery": {
    "description": "Request to submit query",
    "type": "object",
    "properties": {
      "fqlQuery": {
        "type": "string"
      },
      "entityTypeId": {
        "$ref": "common.json#/UUID"
      },
      "fields": {
        "description": "Fields to be included in query results",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "sortResults": {
        "description": "Whether to sort results based on entity type's sort criteria",
        "type": "boolean"
      },
      "maxSize": {
        "description": "Maximum number of results to retrieve for the query",
        "type": "integer"
      }
    },
    "required": [
      "entityTypeId",
      "fqlQuery"
    ],
    "additionalProperties": false
  },
  "ContentsRequest": {
    "description": "Request for a set of contents",
    "type": "object",
    "properties": {
      "entityTypeId": {
        "$ref": "common.json#/UUID"
      },
      "fields": {
        "description": "Fields to be included in results",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "ids": {
        "description": "Ids to retrieve results for",
        "type": "array",
        "items": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "localize": {
        "description": "Whether to localize dates in content response",
        "type": "boolean",
        "default": false
      },
      "userId": {
        "$ref": "common.json#/UUID"
      }
    },
    "required": [
      "entityTypeId",
      "fields",
      "ids"
    ],
    "additionalProperties": false
  }
}