Working list

Resource type: workinglist

This API call can be used to create worklists for estates and addresses in enterprise. Currently there is only the create call for worklists, no modify or delete.

To create public lists (visibility 0), the user right “Create public filters / work lists” at “Extras >> Settings >> User >> Rigths” is required.
To create shop window TV lists (stv_flag), the user right “Create storefront TV lists” at “Extras >> Settings >> User >> Rigths” is required.

Parameters:

  • listName
    STRING. Name of the worklist.
  • type
    STRING. Type of the worklist. Possible values: estate, address
  • visibility
    INTEGER. Visibility of the worklist: Possible values: 0 – public list, 1 – private list, 2 – public group list.
  • stv_flag
    BOOLEAN. If true, a shop window TV list is created. Parameter visibility is then ignored.
  • userId
    INTEGER. Id of the user for whom the worklist should be created. It is specified together with visibility 1. If no userid is specified, the ID of the logged in user is set.
  • groupId
    INTEGER. Id of the group for which the worklist should be created. It is specified together with visibility 2. If no groupid is specified, the ID of the office group of the logged in user is set.
  • ids
    ARRAY. The IDs of the records to be included in the worklist.

Example:

...
    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create",
        "resourceid": "",
        "identifier": "",
        "resourcetype": "workinglist",
        "parameters": {
            "userId": 25,
            "listName": "Immobilienliste",
            "visibility": 1,
            "type": "estate",
            "ids": [
                1061,
                1065,
                1069
            ]
        }
    }
...