System - Get web-part properties

API Url

Used for loading properties of a web-part

GET

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 from where the properties are loaded.(5 = System, 10 = Employee category, 15 = User profile)
levelId`optional`	String	The category or user profile. (Only for level > 5)

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
properties	Object[]	Collection of web-part properties.
id	String	Property unique identifier.
level	Boolean	Level of property.(0 = ProMark, 5 = System, 10 = Employee category, 15 = User profile, 20 = Portal User, 25 = Current)
locked	Boolean	true = Web-part property is read-only.
name	String	Name of property.
type	Number	Type of property.
value	String	Value of property.
visible	Boolean	true = Web-part property is visible to the user.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
           "properties": [
               {
                  "id": "ActDeptDes",
                  "name": "Show actual department description",
                  "value": "FALSE",
                  "type": 2,
                  "visible": true,
                  "locked": false,
                  "level": 5
               },
               {
                  "id": "ActDeptId",
                  "name": "Show act department ID",
                  "value": "FALSE",
                  "type": 2,
                  "visible": true,
                  "locked": false,
                  "level": 5
               }
            ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

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.