v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
holidayRules

Update holiday rule(s) and invalidate overlapping schedules for re-evaluation

patch/api/serviceattendance/processes/holidayRules/updateHolidayRules

Request body

OR

Example request

{
  "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
  "createdAt": "2021-05-05T01:02:03.924Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "companyUuid": "5f010f1e-6fc1-447f-93a8-fad19668b3af",
  "holidayRuleSettingUuid": "8b2a3c4d-5e6f-7890-abcd-ef1234567890",
  "active": true,
  "conditions": {
    "all": [
      {
        "fact": "originalShift",
        "operator": "isOn",
        "value": "2025-12-25T08:00:00.000Z",
        "path": "$.shiftStartDate",
        "params": {
          "tz": "America/Los_Angeles"
        }
      }
    ]
  },
  "event": {
    "type": "holiday",
    "params": {
      "message": "Christmas Day Holiday",
      "referenceUuid": {
        "fact": "workerUuid"
      },
      "referenceType": "worker"
    }
  },
  "name": "Christmas Day (HOLIDAY RULE)",
  "description": "Christmas Day holiday rule with enhanced pay rate and timesheet creation",
  "priority": 1,
  "version": "0.1.0",
  "formatter": "jsonRulesEngine",
  "rateMultiplierSettings": {
    "active": true,
    "multiplier": 1.5
  },
  "createdTimesheetSettings": {
    "active": true,
    "lengthMinutes": 240
  },
  "isRecurring": true,
  "startDate": "2025-12-25T00:00:00.000Z",
  "deletedAt": "2017-07-21T17:32:28Z",
  "deletedBy": "f4428d27-c089-40c4-aa83-ce02e1ee1426"
}

Response

Holiday rule(s) updated successfully

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "companyUuid": "5f010f1e-6fc1-447f-93a8-fad19668b3af",
    "holidayRuleSettingUuid": "8b2a3c4d-5e6f-7890-abcd-ef1234567890",
    "active": true,
    "conditions": {
      "all": [
        {
          "fact": "originalShift",
          "operator": "isOn",
          "value": "2025-12-25T08:00:00.000Z",
          "path": "$.shiftStartDate",
          "params": {
            "tz": "America/Los_Angeles"
          }
        }
      ]
    },
    "event": {
      "type": "holiday",
      "params": {
        "message": "Christmas Day Holiday",
        "referenceUuid": {
          "fact": "workerUuid"
        },
        "referenceType": "worker"
      }
    },
    "name": "Christmas Day (HOLIDAY RULE)",
    "description": "Christmas Day holiday rule with enhanced pay rate and timesheet creation",
    "priority": 1,
    "version": "0.1.0",
    "formatter": "jsonRulesEngine",
    "rateMultiplierSettings": {
      "active": true,
      "multiplier": 1.5
    },
    "createdTimesheetSettings": {
      "active": true,
      "lengthMinutes": 240
    },
    "isRecurring": true,
    "startDate": "2025-12-25T00:00:00.000Z",
    "deletedAt": "2017-07-21T17:32:28Z",
    "deletedBy": "f4428d27-c089-40c4-aa83-ce02e1ee1426"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}