POST api/consumer/v1/visibilityRules

Create a new rule

Request Information

URI Parameters

None

Body Parameters

The rule

VisibilityRuleEditDto
NameDescriptionTypeAdditional information
EntityId

The target's entity identifier

 integer

Required
EntityTypeId

The type of the entity

 VisibilityEntityType

Required
RuleId

Rule to apply

 integer

Required
RuleEntityId

The subject of the rule

 integer

Required
CanModify

Modify: True/False

 boolean

Required
CanDelete

Delete: True/False

 boolean

Required
Id

Unique ID

 integer

None

Request Formats

application/json, text/json

Sample: 
{
  "EntityId": 1,
  "EntityTypeId": 100,
  "RuleId": 2,
  "RuleEntityId": 3,
  "CanModify": true,
  "CanDelete": true,
  "Id": 6
}

application/xml, text/xml

Sample: 
<VisibilityRuleEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>6</Id>
  <CanDelete>true</CanDelete>
  <CanModify>true</CanModify>
  <EntityId>1</EntityId>
  <EntityTypeId>BusinessUnit</EntityTypeId>
  <RuleEntityId>3</RuleEntityId>
  <RuleId>2</RuleId>
</VisibilityRuleEditDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None
Content

HttpContent

None
StatusCode

HttpStatusCode

None
ReasonPhrase

string

None
Headers

Collection of Object

None
RequestMessage

HttpRequestMessage

None
IsSuccessStatusCode

boolean

None