Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all tasks
  • Request
  • Response
  • Add task
  • Request
  • Response

Was this helpful?

  1. API Operations

Tasks

Get all tasks

Returns all tasks of the enterprise, filtered by identifiers or other filters.

Request

[PlatformAddress]/api/connector/v1/tasks/getAll

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "TaskIds": [
    "65cf1aac-bef2-4653-9350-ab2600af65af"
  ],
  "DepartmentIds": [
    "c28cfb42-a963-4195-ad26-ab1b009b6425"
  ],
  "ServiceOrderIds": [
    "8d70f718-e19c-458d-8ddb-ab1b009b5487"
  ],
  "CreatedUtc": {
    "StartUtc": "2019-12-08T00:00:00Z",
    "EndUtc": "2019-12-10T00:00:00Z"
  },
  "ClosedUtc": {
    "StartUtc": "2019-12-08T00:00:00Z",
    "EndUtc": "2019-12-10T00:00:00Z"
  },
  "DeadlineUtc": {
    "StartUtc": "2020-01-01T00:00:00Z",
    "EndUtc": "2020-01-02T00:00:00Z"
  }
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

EnterpriseIds

array of string

optional, max 1000 items

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

CreatedUtc

optional, max length 3 months

Interval in which the Task was created.

ClosedUtc

optional, max length 3 months

Interval in which the Task was closed.

DeadlineUtc

optional, max length 3 months

Interval in which the Task has a deadline.

TaskIds

array of string

optional, max 1000 items

DepartmentIds

array of string

optional, max 1000 items

ServiceOrderIds

array of string

optional, max 1000 items

Unique identifiers of service orders (reservations or product service orders).

Limitation

required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "Tasks": [
    {
      "Id": "b166fc93-c75a-438f-93b8-ab1e00a031ae",
      "Name": "Test all",
      "State": "Open",
      "Description": "Task description",
      "DepartmentId": "c28cfb42-a963-4195-ad26-ab1b009b6425",
      "ServiceOrderId": "8d70f718-e19c-458d-8ddb-ab1b009b5487",
      "CreatedUtc": "2019-12-09T09:43:14Z",
      "DeadlineUtc": "2020-01-01T14:00:00Z",
      "ClosedUtc": null
    }
  ]
}
Property
Type
Contract
Description

Tasks

required

The filtered tasks.

Cursor

string

optional

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Task

Property
Type
Contract
Description

Id

string

required

Unique identifier of the task.

EnterpriseId

string

required

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

Name

string

required

Name (or title) of the task.

State

string

required

State of the task.

Description

string

optional

Further description of the task.

DepartmentId

string

optional

Unique identifier of the Department the task is addressed to.

ServiceOrderId

string

optional

Unique identifier of the service order (reservation or product service order) the task is linked with.

CreatedUtc

string

required

Creation date and time of the task in UTC timezone in ISO 8601 format.

DeadlineUtc

string

required

Deadline date and time of the task in UTC timezone in ISO 8601 format.

ClosedUtc

string

required

Last update date and time of the task in UTC timezone in ISO 8601 format.

Add task

Adds a new task to the enterprise, optionally to a specified department.

Request

[PlatformAddress]/api/connector/v1/tasks/add

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "Name": "Test",
  "Description": "Task description",
  "DeadlineUtc": "2016-01-01T14:00:00Z",
  "ServiceOrderId": "c73cf884-ae2b-4fba-858c-ab1400b4c8c3",
  "DepartmentId": "8a0770a7-5178-4b87-8898-ab0400a346ec"
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

DepartmentId

string

optional

ServiceOrderId

string

optional

Unique identifier of the service order (reservation or product service order) the task is linked with.

Name

string

required

Name (or title) of the task.

Description

string

optional

Further decription of the task.

DeadlineUtc

string

required

Deadline of the task in UTC timezone in ISO 8601 format.

Response

{
  "TaskId": "11bcf947-d629-4781-89f9-ab1800d5aa47"
}
Property
Type
Contract
Description

TaskId

string

required

Unique identifier of added task.

PreviousSourcesNextTax environments

Last updated 6 months ago

Was this helpful?

Unique identifiers of .

Unique identifiers of . Not possible to be used standalone, needs to be used in combination with other filters.

array of

Unique identifier of the the task is addressed to.

Tasks
Task
Limitation
Time interval
Time interval
Time interval
Departments
Department