GET FilterRules/{id}

Gets a filter rule FilterRuleResponse , by its Id.


Parameters

NameDescriptionAdditional information
id
The Id of the filter rule.

Define this parameter in the request URI.

Response body formats

A FilterRuleResponse, containing the FilterRule if found.

application/json, text/json

Sample:
{
  "Item": {
    "FilterId": 1,
    "Parent": 0,
    "Child": 0,
    "RuleValues": {
      "1": {
        "FilterRuleId": 1,
        "ParentId": 2,
        "ChildId": 3,
        "FilterId": 4,
        "CreatedOn": "2025-01-26T07:11:00.5440936+00:00",
        "CreatedBy": 6
      },
      "2": {
        "FilterRuleId": 1,
        "ParentId": 2,
        "ChildId": 3,
        "FilterId": 4,
        "CreatedOn": "2025-01-26T07:11:00.5440936+00:00",
        "CreatedBy": 6
      },
      "3": {
        "FilterRuleId": 1,
        "ParentId": 2,
        "ChildId": 3,
        "FilterId": 4,
        "CreatedOn": "2025-01-26T07:11:00.5440936+00:00",
        "CreatedBy": 6
      }
    },
    "ParentUdfId": 2,
    "ChildUdfId": 3,
    "Enabled": true,
    "CreatedOn": "2025-01-26T07:11:00.5440936+00:00",
    "CreatedBy": 6
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<FilterRuleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Child>All</d2p1:Child>
    <d2p1:ChildUdfId>3</d2p1:ChildUdfId>
    <d2p1:CreatedBy>6</d2p1:CreatedBy>
    <d2p1:CreatedOn>2025-01-26T07:11:00.5440936+00:00</d2p1:CreatedOn>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:FilterId>1</d2p1:FilterId>
    <d2p1:Parent>All</d2p1:Parent>
    <d2p1:ParentUdfId>2</d2p1:ParentUdfId>
    <d2p1:RuleValues xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintFilterRuleValues19w73moz>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>
          <d2p1:ChildId>3</d2p1:ChildId>
          <d2p1:CreatedBy>6</d2p1:CreatedBy>
          <d2p1:CreatedOn>2025-01-26T07:11:00.5440936+00:00</d2p1:CreatedOn>
          <d2p1:FilterId>4</d2p1:FilterId>
          <d2p1:FilterRuleId>1</d2p1:FilterRuleId>
          <d2p1:ParentId>2</d2p1:ParentId>
        </d3p1:Value>
      </d3p1:KeyValueOfintFilterRuleValues19w73moz>
      <d3p1:KeyValueOfintFilterRuleValues19w73moz>
        <d3p1:Key>2</d3p1:Key>
        <d3p1:Value>
          <d2p1:ChildId>3</d2p1:ChildId>
          <d2p1:CreatedBy>6</d2p1:CreatedBy>
          <d2p1:CreatedOn>2025-01-26T07:11:00.5440936+00:00</d2p1:CreatedOn>
          <d2p1:FilterId>4</d2p1:FilterId>
          <d2p1:FilterRuleId>1</d2p1:FilterRuleId>
          <d2p1:ParentId>2</d2p1:ParentId>
        </d3p1:Value>
      </d3p1:KeyValueOfintFilterRuleValues19w73moz>
      <d3p1:KeyValueOfintFilterRuleValues19w73moz>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>
          <d2p1:ChildId>3</d2p1:ChildId>
          <d2p1:CreatedBy>6</d2p1:CreatedBy>
          <d2p1:CreatedOn>2025-01-26T07:11:00.5440936+00:00</d2p1:CreatedOn>
          <d2p1:FilterId>4</d2p1:FilterId>
          <d2p1:FilterRuleId>1</d2p1:FilterRuleId>
          <d2p1:ParentId>2</d2p1:ParentId>
        </d3p1:Value>
      </d3p1:KeyValueOfintFilterRuleValues19w73moz>
    </d2p1:RuleValues>
  </Item>
</FilterRuleResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body