Skip to content

Get all tasks

POST
/api/connector/v1/tasks/getAll

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

TaskFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

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

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

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

Array<string>
nullable >= 1 items <= 1000 items
CreatedUtc
TimeFilterInterval

Interval in which the Task was created.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ClosedUtc
TimeFilterInterval

Interval in which the Task was closed.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
DeadlineUtc
TimeFilterInterval

Interval in which the Task has a deadline.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
TaskIds

Unique identifiers of Tasks.

Array<string>
nullable >= 1 items <= 1000 items
DepartmentIds

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

Array<string>
nullable >= 1 items <= 1000 items
ServiceOrderIds

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

Array<string>
nullable >= 1 items <= 1000 items
Example
{
"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"
}
}

OK

TaskResult
object
Tasks
required

The filtered tasks.

Array<object>
Task
object
Id

Unique identifier of the task.

string format: uuid
EnterpriseId

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

string format: uuid
Name
required

Name (or title) of the task.

string
>= 1 characters
State
required

State of the task.

string
>= 1 characters
Description

Further description of the task.

string
nullable
DepartmentId

Unique identifier of the Department the task is addressed to.

string format: uuid
nullable
ServiceOrderId

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

string format: uuid
nullable
CreatedUtc
required

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

string
>= 1 characters
DeadlineUtc
required

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

string
>= 1 characters
ClosedUtc
required

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

string
>= 1 characters
Cursor

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.

string format: uuid
nullable
Example
{
"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
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable