Jump to: navigation, search

Query Rules In Package

Method

GET

Syntax

 
/grs/v1/tenant/{tenantId}/package/{packageId}/rules

Optional parameters:

  • &nodeId=457
  • &baseSalience=99000

Request Body

N/A

Response Body

 
{   
   "rules":[   
      {   
         "ruleId":"f22d35f6-e31e-41f2-8e62-97864c47579a",
         "ruleType":"DECISION_TABLE",
         "extRuleId":"DT-163",
         "name":"DEF",
         "description":"Sample2",
         "phase":"2nd",
         "splitTest": "A",
         "calendarId":"Calendar_117",
         "nodeId":"pkg",
         "locked":false,
         "lockOwner":null,
         "dateEffective":null,
         "dateExpired":null,
         "pendingSnapshot":true
      },
      {   
         "ruleId":"820a0434-9e46-4a44-b0e7-fea201a17282",
         "ruleType":"DECISION_TABLE",
         "extRuleId":"DT-186",
         "name":"3rd",
         "description":"",
         "phase":"3rd",
         "splitTest": "A", 
         "calendarId":"none",
         "nodeId":"pkg",
         "locked":false,
         "lockOwner":null,
         "dateEffective":null,
         "dateExpired":null,
         "pendingSnapshot":true
      },
      {   
         "ruleId":"a60416af-80a9-4378-be58-785c12b3ba8e",
         "ruleType":"LINEAR",
         "extRuleId":"Rule-100",
         "name":"1st Date",
         "description":"Basic criteria",
         "phase":"1st",
         "splitTest": "A",
         "calendarId":"none",
         "nodeId":"pkg",
         "locked":false,
         "lockOwner":null,
         "dateEffective":null,
         "dateExpired":null,
         "pendingSnapshot":true
      },
      {   
         "ruleId":"061619bb-de47-4bda-80a1-2e1ade5fa010",
         "ruleType":"LINEAR",
         "extRuleId":"Rule-110",
         "name":"Default",
         "description":"Default is NO WAY BUDDY",
         "phase":"--none--",
         "splitTest": "A", 
         "calendarId":"none",
         "nodeId":"pkg",
         "locked":false,
         "lockOwner":null,
         "dateEffective":null,
         "dateExpired":null,
         "pendingSnapshot":true
      },
      {   
         "ruleId":"65cda7d5-09b4-47ec-9f7d-d90144be7f89",
         "ruleType":"LINEAR",
         "extRuleId":"Rule-130",
         "name":"Check day",
         "description":"No dating on holidays!",
         "phase":"--none--",
         "splitTest": "A", 
         "calendarId":"Calendar_117",
         "nodeId":"pkg",
         "locked":false,
         "lockOwner":null,
         "dateEffective":null,
         "dateExpired":null,
         "pendingSnapshot":true
      }
   ]
}

HTTP Status Codes

  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant ID, or does not have the correct permission for this operation.
  • 404 Not Found—could not find specified package ID. Use Query Packages to obtain correct ID.
  • 503—Service Unavailable

Notes

User must have RULE_VIEW permission By default, this query returns all rules in the specified package. To further filter, specify: &nodeId, which returns only rules at that node within the rule package. Notes: If "nodeId" is set to "pkg", API will return only rules at the package level. For sub-node, set both "nodeId" and "baseSalience" values for the node being queried. Both of these are returned on the "Query Business Hierarchy" API.

This page was last edited on March 2, 2018, at 10:14.
Comments or questions about this documentation? Contact us for support!