Mews · Schema

TaskFilterParameters

HospitalityHotelsPMSProperty Management

Properties

Name Type Description
ClientToken string Token identifying the client application.
AccessToken string Access token of the client application.
Client string Name and version of the client application.
Limitation object Limitation on the quantity of data returned and optional Cursor for the starting point of data.
EnterpriseIds array Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
CreatedUtc object Interval in which the Task was created.
ClosedUtc object Interval in which the Task was closed.
DeadlineUtc object Interval in which the Task has a deadline.
TaskIds array Unique identifiers of [Tasks](https://mews-systems.gitbook.io/connector-api/operations/#task).
DepartmentIds array Unique identifiers of [Departments](https://mews-systems.gitbook.io/connector-api/operations/departments/#department). Not possible to be used standalone, needs to be used in combination with other fi
ServiceOrderIds array Unique identifiers of service orders (reservations or product service orders).
View JSON Schema on GitHub

JSON Schema

mews-taskfilterparameters-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TaskFilterParameters",
  "title": "TaskFilterParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "Limitation"
  ],
  "type": "object",
  "properties": {
    "ClientToken": {
      "minLength": 1,
      "type": "string",
      "description": "Token identifying the client application."
    },
    "AccessToken": {
      "minLength": 1,
      "type": "string",
      "description": "Access token of the client application."
    },
    "Client": {
      "minLength": 1,
      "type": "string",
      "description": "Name and version of the client application."
    },
    "Limitation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Limitation"
        }
      ],
      "description": "Limitation on the quantity of data returned and optional Cursor for the starting point of data."
    },
    "EnterpriseIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.",
      "nullable": true
    },
    "CreatedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the Task was created.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "ClosedUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the Task was closed.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "DeadlineUtc": {
      "title": "Time interval",
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeFilterInterval"
        }
      ],
      "description": "Interval in which the Task has a deadline.",
      "nullable": true,
      "x-max-interval-in-months": 3
    },
    "TaskIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Tasks](https://mews-systems.gitbook.io/connector-api/operations/#task).",
      "nullable": true
    },
    "DepartmentIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of [Departments](https://mews-systems.gitbook.io/connector-api/operations/departments/#department). Not possible to be used standalone, needs to be used in combination with other filters.",
      "nullable": true
    },
    "ServiceOrderIds": {
      "maxItems": 1000,
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Unique identifiers of service orders (reservations or product service orders).",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "TaskFilterParameters"
}