Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListAvailableUserTasks

List the available UserTasks for the current user.

The response has a Aggregations property. This property contains the available filters for this set of UserTasks. To apply such a filter it should added in the Filters property on the RequestMessage.

Example response:

{
...
,
  "Aggregations": {
      "ZonedCycleCountPreCount": {
        "CycleCountZoneID": [
          {
            "Name": "Shelves",
            "Value": 10,
            "Count": 1
          },
          {
            "Name": "Stockroom",
            "Value": 12,
            "Count": 6
          },
          {
            "Name": "Store",
            "Value": 13,
            "Count": 4
          }
        ]
      }
    }
  }
}

To apply a matching filter:

{
  "Filters": {
    "ZonedCycleCountPreCount": {
      "CycleCountZoneID": [10]
    }
  }
}

Hierarchy

  • ListAvailableUserTasks

Index

Properties

Optional Filters

Filters: undefined | {}

Filter for a specific UserTaskType.Name using a property name and a list of values.

Optional IsStarted

IsStarted: undefined | false | true

Return only Started/Open UserTasks

Optional Labels

Labels: string[]

Return only UserTasks with one of the specified labels

Optional UserID

UserID: undefined | number

Return only UserTasks attached to this UserID Entity type: User

Optional UserTaskSubTypes

UserTaskSubTypes: string[]

Return only UserTasks with one of the specified subtypes

Optional UserTaskTypes

UserTaskTypes: string[]

Return only UserTasks of one of the specified types