PATCH Method

The HTTP PATCH method can be used in two different ways:

Modify a Resource

Each HTTP PATCH request that modifies a resource requires a request body. The body must contain properties with modified values. For example, to modify a data collection schedule, send the following request:

Request:

PATCH https://one-srv:1239/api/v2.1/dataCollection/schedule

 

Request Body:

{

 "startTime": "2020-12-18T21:00:00Z",

 "timeZoneId": "",

 "scheduleType": "Daily",

 "disabled": false,

 "periodically": {

   "period": 1,

   "interval": "Hours"

 },

 "daily": {

   "daysOfWeek": [

     "Monday",

     "Tuesday",

     "Wednesday",

     "Thursday",

     "Friday"

   ]

 },

 "monthlyDays": {

   "months": [],

   "days": []

 },

 "monthlyWeekDays": {

   "months": [],

   "dayOfWeekAppearance": [],

   "daysOfWeek": [

     "Monday",

     "Tuesday",

     "Wednesday",

     "Thursday",

     "Friday"

   ]

 }

}

Post an Action

For example, to update a license, send the following request:

Request:

PATCH https://one-srv:1239/api/v2.1/license/update

In case of success, the HTTP PATCH method returns the 200 Success response code.