{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants Users Rules API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Users Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get dependents for a users rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/users/rules/:ruleId/dependents",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "The ID of the rule for which to retrieve dependents"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results per page"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order for dependents (by last run date, then created date)"
              }
            ]
          },
          "docs": "Get dependents for a users rule"
        },
        {
          "info": {
            "name": "Get dependent of a users rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/users/rules/:ruleId/dependents/:ruleType/:typeId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "The ID of the rule for which to retrieve dependents"
              },
              {
                "name": "ruleType",
                "value": "",
                "type": "path",
                "description": "The type of the dependent"
              },
              {
                "name": "typeId",
                "value": "",
                "type": "path",
                "description": "The type ID of the dependent"
              }
            ]
          },
          "docs": "Get dependent of a users rule"
        },
        {
          "info": {
            "name": "Get a users rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/users/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "The ID of the rule to retrieve"
              }
            ]
          },
          "docs": "Get a users rule"
        },
        {
          "info": {
            "name": "Update an existing users rule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/users/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "The ID of the rule to update"
              }
            ]
          },
          "docs": "This will update an existing users rule with the specified fields."
        },
        {
          "info": {
            "name": "Delete an existing users rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/users/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "The id of the rule"
              }
            ]
          },
          "docs": "Delete an existing users rule"
        },
        {
          "info": {
            "name": "Get the list of users rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/users/rules",
            "params": [
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results per page"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "The types of the rule"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Fields to expand in response"
              },
              {
                "name": "enabled",
                "value": "",
                "type": "query",
                "description": "Whether to list enabled or disabled rules"
              },
              {
                "name": "searchTerm",
                "value": "",
                "type": "query",
                "description": "a search term for finding a rule by name"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "sort rules by name, ascending, descending"
              }
            ]
          },
          "docs": "Get the list of users rules"
        },
        {
          "info": {
            "name": "Create a new rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/users/rules"
          },
          "docs": "This will create a new rule with the specified fields."
        },
        {
          "info": {
            "name": "Query the result of a users rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/users/rules/query",
            "params": [
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results per page"
              }
            ]
          },
          "docs": "This will query the result of a rule."
        },
        {
          "info": {
            "name": "Get the settings for a specific users rule type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/users/rules/settings/:ruleType",
            "params": [
              {
                "name": "ruleType",
                "value": "",
                "type": "path",
                "description": "The type of the rule"
              }
            ]
          },
          "docs": "Get the settings for a specific users rule type"
        }
      ]
    }
  ],
  "bundled": true
}