GET api/consumer/v1/visibilityRules/{ruleId}

Get a rule

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ruleId

ID

 integer

Required

Body Parameters

None

Response Information

Resource Description

The Visibility Rule

VisibilityRuleDto
NameDescriptionTypeAdditional information
EntityId

The target's entity identifier

 integer

None
EntityType

Type of the entity

 ItemIdDescriptionDto

None
Rule

Rule information

 RuleToApplyMinDto

None
RuleEntity

Entity subject of the rule

 ItemIdDescriptionDto

None
CanModify

Modify permission: True/False

 boolean

None
CanDelete

Modify permission: True/False

 boolean

None
Id

Unique ID

 integer

None

Response Formats

application/json, text/json

Sample: 
{
  "EntityId": 1,
  "EntityType": {
    "Id": 1,
    "Description": "sample string 2"
  },
  "Rule": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Id": 3
  },
  "RuleEntity": {
    "Id": 1,
    "Description": "sample string 2"
  },
  "CanModify": true,
  "CanDelete": true,
  "Id": 4
}

application/xml, text/xml

Sample: 
<VisibilityRuleDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>4</Id>
  <CanDelete>true</CanDelete>
  <CanModify>true</CanModify>
  <EntityId>1</EntityId>
  <EntityType>
    <Description>sample string 2</Description>
    <Id>1</Id>
  </EntityType>
  <Rule>
    <Id>3</Id>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </Rule>
  <RuleEntity>
    <Description>sample string 2</Description>
    <Id>1</Id>
  </RuleEntity>
</VisibilityRuleDto>