v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Collective Schedules

List Collective Schedules from a Working Time Arrangement

<Warning> **This is a beta feature.** You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. </Warning>

Get the list of Collective Schedules from a Working Time Arrangement by id

get/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules

Path parameters

workingTimeArrangementIdinteger required

The unique identifier of the Working Time Arrangement.

Query parameters

limitinteger

Page size

pageinteger

Page number

fields.root'count'

Include collection properties.

sort'-startsOn'

Sort items by a property.

Response

OK

Example response

{
  "items": [
    {
      "pattern": {
        "monday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        },
        "tuesday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        },
        "wednesday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        },
        "thursday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        },
        "friday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        },
        "saturday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        },
        "sunday": {
          "shifts": [
            {
              "duration": {
                "iso": "PT7H30M"
              }
            }
          ],
          "workDuration": {
            "iso": "PT7H30M"
          }
        }
      }
    }
  ]
}