DocumentationWorkfrontWorkfront Guide

Users available time API

Last update: Tue Nov 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

URI: attask/api/v15.0/user/getUsersAvailableTime

The users available time endpoint retrieves data on the user’s available time. This allows integrations for aggregation of data according to user attributes and time intervals.

Example request

curl -XPUT /attask/api/v15.0/user/getUsersAvailableTime

Request parameters

  • userIDs: array of strings. Required. Example: "61a9cc0500002f9fdaa7a6f824f557e1".

  • fromDate: datetime. string. Required. Example: "2022-07-10T00:00:00".

  • toDate: datetime. string. Required. Example "2022-07-20T23:59:59".

Example response:

{
    "data": {
        "result": {
            "PAVL": {
                "61a9cc0500002f9fdaa7a6f824f557e1": [
                    0.0,
                    480.0,
                    480.0,
                    480.0,
                    480.0,
                    480.0,
                    0.0,
                    0.0,
                    480.0,
                    480.0,
                    480.0
                ]
            },
            "AVL": {
                "61a9cc0500002f9fdaa7a6f824f557e1": [
                    0.0,
                    480.0,
                    480.0,
                    480.0,
                    480.0,
                    0.0,
                    480.0,
                    0.0,
                    480.0,
                    480.0,
                    480.0
                ]
            }
        }
    }
}

Response parameters

  • AVL: Actual available hours. Array of numbers.
  • PAVL: Pure available hours for scheduling that does not include non-working days or user time off. String.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43