POST {clientId}/DataExport/SegmentGroupPermissions

Add SegmentGroup Permissions.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.

string

Required

Body Parameters

SegmentGroupPermission class instance containing list of segment group permissions to import

SegmentGroupPermissionResult
NameDescriptionTypeAdditional information
SegmentGroupPermissions

Collection of SegmentGroupPermission

None.

Request Formats

application/json, text/json

Sample:
{
  "SegmentGroupPermissions": [
    {
      "SearchLink": 1,
      "ClientLink": 2,
      "UserGroupLink": 3,
      "SegmentGroupName": "sample string 4",
      "UserGroupName": "sample string 5",
      "FolderName": "sample string 6",
      "CanView": true,
      "CanEdit": true,
      "CanExecute": true,
      "Special": 10
    }
  ]
}

application/xml, text/xml

Sample:
<SegmentGroupPermissionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <SegmentGroupPermissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:SegmentGroupPermission>
      <d2p1:CanEdit>true</d2p1:CanEdit>
      <d2p1:CanExecute>true</d2p1:CanExecute>
      <d2p1:CanView>true</d2p1:CanView>
      <d2p1:ClientLink>2</d2p1:ClientLink>
      <d2p1:FolderName>sample string 6</d2p1:FolderName>
      <d2p1:SearchLink>1</d2p1:SearchLink>
      <d2p1:SegmentGroupName>sample string 4</d2p1:SegmentGroupName>
      <d2p1:Special>10</d2p1:Special>
      <d2p1:UserGroupLink>3</d2p1:UserGroupLink>
      <d2p1:UserGroupName>sample string 5</d2p1:UserGroupName>
    </d2p1:SegmentGroupPermission>
  </SegmentGroupPermissions>
</SegmentGroupPermissionResult>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

  • Unauthorized (401)
  • InternalServerError (500)
  • BadRequest (400)

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.