Time Constraints (policy-time-restriction-type)

Basic Parameters

Parameter	Type	Required	Default Value	Description	Rules
name	String	Yes	-	Policy Name	API must be unique in Proxy
description	String	No	-	Policy Description	-
actionType	Enum	No	RESTRICT	Restriction type	-
zoneId	String	No	+03:00	Time Frame	Must be valid time frame
restrictionList	List<Rule>	Yes	[ ]	Time Restriction Rules	Must contain at least one rule

actionType Values

Value	Description
ALLOW	Allow at specified times, block at other times
RESTRICT	Block at specified times, allow at other times

Rule (Time Contraints) Parameters

Parameter	Type	Required	Default Value	Description	Rules
description	String	No	-	Rule explanation	-
dayType	Enum	Yes	WEEK	Day Type	-
enumWeekDayList	List<Enum>	Conditional	[ ]	Days of the week	Required if dayType=WEEK
day	Integer	Conditional	-	Day of the month	Required if dayType=CUSTOM, between 0-31
month	Integer	Conditional	-	month	Required if dayType=CUSTOM, between 0-12
wholeDay	Boolean	No	false	All day application	-
startHour	Integer	Conditional	-	Start time	Required if wholeDay=false, between 0-24
startMinute	Integer	Conditional	-	Start minute	Required if wholeDay=false, between 0-60
startSecond	Integer	Conditional	-	Start second	Required if wholeDay=false, between 0-60
endHour	Integer	Conditional	-	End time	Required if wholeDay=false, between 0-24
endMinute	Integer	Conditional	-	End minute	Required if wholeDay=false, between 0-60
endSecond	Integer	Conditional	-	End second	Required if wholeDay=false, between 0-60

dayTypeValues

Value	Description
WEEK	Restriction by days of the week
CUSTOM	Custom date-based restriction (day/month)

enumWeekDayList Values

Value
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
ALL

Example JSON Structures

1. Weekday Working Hours Restriction

{
  "operationMetadata" : {
    "targetScope" : "ALL",
    "targetPipeline" : "REQUEST",
    "deploy" : true,
    "deployTargetEnvironmentNameList": [
      "test", "prod"
    ],
    "order" : 1
  },
  "policy" : {
    "type" : "policy-time-restriction",
    "name" : "Restriction on Working Hours",
    "description" : "Allow access between 09:00-18:00 on weekdays",
    "actionType" : "ALLOW",
    "zoneId" : "+03:00",
    "restrictionList" : [ {
      "description" : "Working hours on weekdays",
      "dayType" : "WEEK",
      "enumWeekDayList" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY" ],
      "wholeDay" : false,
      "startHour" : 9,
      "startMinute" : 0,
      "startSecond" : 0,
      "endHour" : 18,
      "endMinute" : 0,
      "endSecond" : 0
    } ]
  }
}

2. Special Day Restriction

{
  "operationMetadata" : {
    "targetScope" : "ALL",
    "targetPipeline" : "REQUEST",
    "deploy" : true,
    "deployTargetEnvironmentNameList": [
      "test", "prod"
    ],
    "order" : 1
  },
  "policy" : {
    "type" : "policy-time-restriction",
    "name" : "SpecialDayRestriction",
    "description" : "Block access for maintenance on the 1st and 15th of each month",
    "actionType" : "RESTRICT",
    "restrictionList" : [
        {
             "description" : "1st of the month",
             "dayType" : "CUSTOM",
             "day" : 1,
             "month" : 0,
             "wholeDay" : true
      }, {
             "description" : "15th of the month",
             "dayType" : "CUSTOM",
             "day" : 15,
             "month" : 0,
             "wholeDay" : true
      }
    ]
  }
}

3. Mixed Restriction

{
  "operationMetadata" : {
    "targetScope" : "ALL",
    "targetPipeline" : "REQUEST",
    "deploy" : true,
    "deployTargetEnvironmentNameList": [
      "test", "prod"
    ],
    "order" : 1
  },
  "policy" : {
    "type" : "policy-time-restriction",
    "name" : "KarmaRestriction",
    "description" : "Block full day weekend and weekday night access",
    "actionType" : "RESTRICT",
    "restrictionList" : [
        {
          "description" : "Weekend restriction",
             "dayType" : "WEEK",
             "enumWeekDayList" : [ "SATURDAY", "SUNDAY" ],
             "wholeDay" : true
      },
        {
             "description" : "Weekday night restriction",
             "dayType" : "WEEK",
             "enumWeekDayList" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY" ],
             "wholeDay" : false,
             "startHour" : 22,
             "startMinute" : 0,
             "startSecond" : 0,
             "endHour" : 6,
             "endMinute" : 0,
             "endSecond" : 0
      }
    ]
  }
}