Filter

PreviousCopy NextFolders

Was this helpful?

Get

Retrieve the filter of a Published item.

GET/api/PubItems/{id}/Filter

Path parameters

id*integer (int32)

Published item ID

Response

Success

Body

rulesnullable array of object

defaultenum

Default assignment type options

0 = Deny,1 = Allow

Request

const response = await fetch('/api/PubItems/{id}/Filter', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "rules": [
    {
      "id": 1,
      "priority": 1,
      "enabled": true,
      "name": "text",
      "description": "text",
      "criteria": {
        "securityPrincipals": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "members": [
            {
              "account": "text",
              "type": [
                "1 = User",
                "2 = Group",
                "3 = ForeignSecurityPrincipal",
                "4 = Computer"
              ],
              "sid": "text"
            }
          ]
        },
        "gateways": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "members": [
            {
              "gatewayIP": "text"
            }
          ]
        },
        "oSs": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "allowedOSes": {
            "chrome": true,
            "android": true,
            "webClient": true,
            "iOS": true,
            "linux": true,
            "mac": true,
            "wyse": true,
            "windows": true
          }
        },
        "iPs": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "allowedIPs": {
            "iPv4s": [
              {
                "from": "text",
                "to": "text"
              }
            ],
            "iPv6s": [
              {
                "from": "text",
                "to": "text"
              }
            ]
          }
        },
        "hardwareIDs": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "members": [
            {
              "hardwareID": "text"
            }
          ]
        },
        "access": [
          "0 = DenyCriteriaWhen",
          "1 = AllowCriteriaWhen"
        ],
        "devices": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "members": [
            {
              "client": "text"
            }
          ]
        },
        "themes": {
          "enabled": true,
          "matchingMode": [
            "0 = IsNotOneOfTheFollowing",
            "1 = IsOneOfTheFollowing"
          ],
          "ids": [
            1
          ]
        }
      }
    }
  ],
  "default": [
    "0 = Deny",
    "1 = Allow"
  ]
}

Update

Update settings of a Published item filter. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/PubItems/{id}/Filter

Path parameters

id*integer (int32)

Published item ID

Body

Published item filter

defaultenum

Default assignment type options

0 = Deny,1 = Allow

Response

No Content

Request

const response = await fetch('/api/PubItems/{id}/Filter', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "default": [
        "0 = Deny",
        "1 = Allow"
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}