Search Results for

    Show / Hide Table of Contents

    Method CreateWatchList

    CreateWatchList(String, WatchListContract)

    Create watch list

    Declaration
    WatchListContract CreateWatchList(string connectionId, WatchListContract watchList)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    WatchListContract watchList

    Watch list to created.

    Returns
    Type Description
    WatchListContract

    The created watch list.

    Remarks

    Create watch list only specific user.

    Examples

    POST http://YourServerName/InfoShare/Json/Common/CreateWatchList

    Example for create watch list.

    {
       "connectionId": "adb26c2e-c9ca-4091-aa59-4ff714539272",
       "WatchLists": [{
         "ChangeDate": "2019-09-27T11:35:12",
         "CreationDate": "2019-09-27T11:35:12",
         "Id": "37100ddd-1ae1-e911-a94b-00155d290a08",
         "Name": "KM_Documents_1",
         "WatchListItems": [{
           "Id": "41100ddd-1ae1-e911-a94b-00155d290a08",
           "ObjectId": "4b99aa54-7c51-e911-a07c-fc77741e4528",
           "ObjectTypeEnum": "Document"
           }, {
           "Id": "4a100ddd-1ae1-e911-a94b-00155d290a08",
           "ObjectId": "fc870cab-7a51-e911-a07c-fc77741e4528",
           "ObjectTypeEnum": "Document"
           }, {
           "Id": "53100ddd-1ae1-e911-a94b-00155d290a08",
           "ObjectId": "d6cae898-7b51-e911-a07c-fc77741e4528",
           "ObjectTypeEnum": "Document" }] }]
    }

    Response:

    {
       "GetWatchListsResult": {
         "SessionCount": 1,
         "WatchLists": [{
           "ChangeDate": "2019-09-27T11:35:12",
           "CreationDate": "2019-09-27T11:35:12",
           "Id": "37100ddd-1ae1-e911-a94b-00155d290a08",
           "Name": "KM_Documents_1",
           "WatchListItems": [{
             "Id": "41100ddd-1ae1-e911-a94b-00155d290a08",
             "ObjectId": "4b99aa54-7c51-e911-a07c-fc77741e4528",
             "ObjectTypeEnum": "Document" 
             }, {
             "Id": "4a100ddd-1ae1-e911-a94b-00155d290a08",
             "ObjectId": "fc870cab-7a51-e911-a07c-fc77741e4528",
             "ObjectTypeEnum": "Document"
             }, {
             "Id": "53100ddd-1ae1-e911-a94b-00155d290a08",
             "ObjectId": "d6cae898-7b51-e911-a07c-fc77741e4528",
             "ObjectTypeEnum": "Document" }] }] }
    }
    Exceptions
    Type Condition
    ServiceException

    The connection id {connectionId} isn't valid or has expired (10008)

    ServiceException

    Verification code is needed: Verification code not yet verified (10152)

    ServiceException

    Object with id {watchList.Id} already exists (10078)

    Back to top Copyright © Kendox