System - Update web-parts

API Url

Used for updating existing web-part instances, typically related to layout.

PUT

http://localhost:16010/ProMarkREST/rest/System/webparts

Permissions: user

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
webparts	Object[]	Collection of web-parts to add.
id	Int64	Web-part unique identifier (not updateable).
name	String	Name of the web-part (not updateable).
order	Number	Order sequence inside the zone (used for layout).
tabId	Number	Tab identifier.
type	Number	Web-part type (not updateable).
zone	Number	Zone identifier (used for layout).

Request example:

{
   "request": {
      "data": {
         "webparts": [
            {
              "id": 1000,
              "type": 2,
              "name": "Attendance overview",
              "tabId": 1,
              "zone": 1,
              "order": 1
            }
         ]
      }
   }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
webparts	Object[]	Collection of web-parts.
id	Int64	Web-part unique identifier. Might be re-generated if web-part changed is inherited.
name	String	Name of the web-part.
order	Number	Order sequence inside the zone (used for layout).
tabId	Number	Tab identifier.
type	Number	Web-part type.
zone	Number	Zone identifier (used for layout).
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": {
         "webparts": [
            {
              "id": 1010,
              "type": 2,
              "name": "Attendance overview",
              "tabId": 1,
              "zone": 1,
              "order": 1
            }
         ]
      },
      "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.

Error example:

HTTP/1.1 404 Not found
{
   "response": {
      "errorCode": 350,
      "errorMessage": "Web-part not found."
   }
}