Create an Operation Rule

This operation creates an operation rule.

More Details

application/json

Request Body

• operationWindow object required

  endDate integer

  Epoch Date value at 12:00 AM of the particular end Date

  name string

  startDate integer

  Epoch Date value at 12:00 AM of the particular start Date

  operations integer[]

  dayTime object[] required

  Add the time interval of the days in dayOfWeek that will be in blackout period

  startTime integer

  Time value

  endTime integer

  dayOfWeek string[] required

  Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

  Select the Day of the week for the rule

  weekOfTheMonth string[] required

  Possible values: [EVERY, FIRST, SECOND, THIRD, FOURTH, LAST]

  Select the week of the month for the blackout window. Select EVERY for all weeks

• entity object

  clientGroupId integer

  clientId integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• error object

  errorCode integer
• operationWindow object

  endDate integer

  name string

  ruleId integer

  startDate integer

  operations integer[]

  dayTime object[]

  startTime integer

  endTime integer

  dayOfWeek integer[]

{
  "error": {
    "errorCode": 0
  },
  "operationWindow": {
    "endDate": 0,
    "name": "string",
    "ruleId": 0,
    "startDate": 0,
    "operations": [
      0
    ],
    "dayTime": [
      {
        "startTime": 0,
        "endTime": 0,
        "dayOfWeek": [
          0
        ]
      }
    ]
  }
}

{
  "error": {
    "errorCode": 0
  },
  "operationWindow": {
    "endDate": 0,
    "name": "Test_1",
    "ruleId": 1,
    "startDate": 0,
    "operations": [
      1,
      2
    ],
    "dayTime": [
      {
        "startTime": 46800,
        "endTime": 50400,
        "dayOfWeek": [
          1,
          2
        ]
      }
    ]
  }
}

Loading...