GET api/consumer/v1/visibilityRules/search?q={q}&pageSize={pageSize}

Get all rules available

Request Information

URI Parameters

NameDescriptionTypeAdditional information
q

String to search

 string

Required
pageSize

Page size

 integer

Default value is 50

Body Parameters

None

Response Information

Resource Description

Rules

Collection of VisibilityRuleSearchDto
NameDescriptionTypeAdditional information
Rule

Rule information

 RuleToApplyMinDto

None
RuleEntity

Entity subject of the rule

 ItemIdDescriptionDto

None

Response Formats

application/json, text/json

Sample: 
[
  {
    "Rule": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "RuleEntity": {
      "Id": 1,
      "Description": "sample string 2"
    }
  },
  {
    "Rule": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Id": 3
    },
    "RuleEntity": {
      "Id": 1,
      "Description": "sample string 2"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVisibilityRuleSearchDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <VisibilityRuleSearchDto>
    <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>
  </VisibilityRuleSearchDto>
  <VisibilityRuleSearchDto>
    <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>
  </VisibilityRuleSearchDto>
</ArrayOfVisibilityRuleSearchDto>