POST {clientId}/DataExport/SegmentPermissions

Add Segment 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

SegmentPermission class instance containing list of segment permissions to import

SegmentPermissionResult
NameDescriptionTypeAdditional information
SegmentPermissions

Collection of SegmentPermission

None.

Request Formats

application/json, text/json

Sample:
{
  "SegmentPermissions": [
    {
      "SearchGroupLink": 1,
      "ClientLink": 2,
      "UserGroupLink": 3,
      "SegmentName": "sample string 4",
      "UserGroupName": "sample string 5",
      "CanView": true,
      "CanEdit": true,
      "CanExecute": true,
      "Special": 9
    }
  ]
}

application/xml, text/xml

Sample:
<SegmentPermissionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <SegmentPermissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:SegmentPermission>
      <d2p1:CanEdit>true</d2p1:CanEdit>
      <d2p1:CanExecute>true</d2p1:CanExecute>
      <d2p1:CanView>true</d2p1:CanView>
      <d2p1:ClientLink>2</d2p1:ClientLink>
      <d2p1:SearchGroupLink>1</d2p1:SearchGroupLink>
      <d2p1:SegmentName>sample string 4</d2p1:SegmentName>
      <d2p1:Special>9</d2p1:Special>
      <d2p1:UserGroupLink>3</d2p1:UserGroupLink>
      <d2p1:UserGroupName>sample string 5</d2p1:UserGroupName>
    </d2p1:SegmentPermission>
  </SegmentPermissions>
</SegmentPermissionResult>

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.