System - Update web-part properties

API Url

Used for updating one or more web-part properties of a specific web-part instance, taking also into consideration the ProMark role (Employee/User).

PUT

http://localhost:16010/ProMarkREST/rest/System/webparts/{id}/properties

Permissions: user

Path parameters

Field	Type	Description
id	Number	Unique identifier of the web-part instance.

Query parameters

Field	Type	Description
level`optional`	Number	The level at which the properties are saved.(5 = System, 10 = Employee category, 15 = User profile)
levelId`optional`	String	The category or user profile. (Only for level > 5)

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
properties	Object[]	Collection of web-part properties.
id	String	Property unique identifier (not updatable).
locked	Boolean	true = Web-part property is read-only (not updatable).
name	String	Name of property (not updatable).
type	Number	Type of property (not updatable).
value	String	Value of property.
visible	Boolean	true = Web-part property is visible to the user (not updatable).

Request example:

{
   "request": {
      "data": {
         "properties":[
            {
               "id": "AbsCol",
               "name": "Show ProMark absence colors",
               "value": "TRUE",
               "type": 2,
               "visible": true,
               "locked": false
            }
         ]
      }
   }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.