{
  "opencollection": "1.0.0",
  "info": {
    "name": "Optibus Operations Driver Absences Work Entities API",
    "version": "2.8.17"
  },
  "items": [
    {
      "info": {
        "name": "Work Entities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List work entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v2/work-entities",
            "params": [
              {
                "name": "depotId",
                "value": "",
                "type": "query",
                "description": "- Optional. The ID of a specific depot for which workEntities are to be retrieved."
              },
              {
                "name": "driverIds",
                "value": "",
                "type": "query",
                "description": "- Optional. An array of driver IDs for whom workEntities are to be retrieved."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "- The start date of the workEntities period."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "- The end date of the workEntities period."
              },
              {
                "name": "exportAllEntities",
                "value": "",
                "type": "query",
                "description": "- Optional. If true, all workEntities will be exported, regardless of the configuration."
              },
              {
                "name": "shouldUseCache",
                "value": "",
                "type": "query",
                "description": "- Optional. Will attempt to retreive the data from the cache if true. If false, will always calculate the data."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves workEntities values for depots within a specified date range and for specified driver IDs or by depotId.\nThere is a limit of 204k work-entities calculation per request to avoid timeouts. This limit enables, for example,\na calculation of 100 drivers for 30 days with 100 daily work-entities defined. In case the limit is exceeded, a 413 error code will be returned, together with the allowed amount of drivers for the existing configuration."
        },
        {
          "info": {
            "name": "Fetch work engine API calculation limit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v2/calculation-limit",
            "params": [
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "- The start date of the calculation period."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "- The end date of the calculation period."
              },
              {
                "name": "mode",
                "value": "",
                "type": "query",
                "description": "- Optional. The flow for which to compute the limit (`payroll` or `workEntities`). Defaults to `payroll`."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Fetches the maximum number of drivers allowed per API request for the given dates for a particular client.\nTo prevent timeouts, there is a cap of 204000 work-entity calculations per request. This cap allows, for instance,\nthe calculation of 100 drivers over a 30-day period with 100 daily work-entities specified.\n\nThe `mode` parameter controls which flow's cost model is used to compute the limit:\n- `payroll` (default): the limit accounts for payroll cycle boundaries that may extend the effective "
        }
      ]
    }
  ],
  "bundled": true
}