Search Results for

    Show / Hide Table of Contents

    Method GetEffectiveAllowedAccessFolder

    GetEffectiveAllowedAccessFolder(String, String, FolderPathContract, List<String>)

    Get effective allowed access folder

    Declaration
    EffectiveResultContract GetEffectiveAllowedAccessFolder(string connectionId, string objectType, FolderPathContract folderPath, List<string> subjectIds)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    System.String objectType

    The object type (Folder or Query). See also ObjectTypeEnum

    FolderPathContract folderPath

    The folderPath. NOTE: If no FolderSystemId is given, the server assumes that it is not a remoteFolder. See also FolderPathContract

    System.Collections.Generic.List<System.String> subjectIds

    The list of subject ids. Example.: (userId, groupId)

    Returns
    Type Description
    EffectiveResultContract

    Return current effective result.

    Examples

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

    Example for get effective allowed access folder.

    {
       "connectionId": "b6742bb8-ef97-44ae-819b-a2fa2200908a",
       "objectType": "Folder",
       "folderPath": {
         "FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
         "Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08
                 \\c5eab4be-a4de-e911-a948-00155d290a08" },
       "subjectIds": ["c40f14e4-64e0-e911-a94a-00155d290a99", "c40f14e4-64e0-e911-a94a-00155d290a99"]
    }

    Response:

    { 
       "GetEffectiveAllowedAccessFolderResult": {
        "EffectiveAccessRights": [{
          "AllowedAccessOperationId": ["01002010-38a7-11d8-a902-0050bf427e8f", "0100201b-38a7-11d8-a902-0050bf427e8f", ...."],
          "SubjectId": "158a23eb-861d-ea11-a99d-00155d290a08"
          }, {
          "AllowedAccessOperationId": ["01002010-38a7-11d8-a902-0050bf427e8f", "01002013-38a7-11d8-a902-0050bf427e8f",..."],
          "SubjectId": "3bfd08a2-b020-ea11-a99d-00155d290a08"
          }] }
    }
    Exceptions
    Type Condition
    ServiceException

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

    ServiceException

    Root folder not found (10023)

    ServiceException

    Folder not found {folderPath} (10025)

    ServiceException

    Search folder not found {searchFolderPath} (10024)

    ServiceException

    Not enough rights ({accessOperationName}, {accessOperationId}) (10071)

    ServiceException

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

    ServiceException

    Not allowed (10014)

    Back to top Copyright © Kendox