System - Add new web-parts

API Url

Used for adding new web-part instances, regardless of tab id. If successful, the request will return back the web-parts & properties collection, having the unique IDs filled in (auto-generated).

POST

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. Needs to be 0!
name	String	Name of the web-part (not important, will be taken from master web-part setup).
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).

Request example:

{
   "request": {
      "data": {
         "webparts": [
            {
              "id": 0,
              "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, auto-generated after a succesful POST.
name	String	Name of the web-part.
order	Number	Order sequence inside the zone (used for layout).
properties`optional`	Object[]	Collection of web-part properties.
id	String	Property unique identifier.
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.
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": 410,
              "type": 2,
              "name": "Attendance overview",
              "tabId": 1,
              "zone": 1,
              "order": 1,
              "properties": [
                  {
                     "id": "ActDeptDes",
                     "name": "Show actual department description",
                     "value": "FALSE",
                     "type": 2,
                     "visible": true,
                     "locked": false
                  },
                  {
                     "id": "ActDeptId",
                     "name": "Show act department ID",
                     "value": "FALSE",
                     "type": 2,
                     "visible": true,
                     "locked": false
                  }
               ]
            }
         ]
      },
      "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."
   }
}