Assignment Rule API’s

These calls can be used to create, update, get all, get details, delete assignment rules. The URL’s and call types are listed in the table below.

HTTP Method	URL	Action
POST	/core/1.0/API/assignmentRule	Create
PATCH	/core/1.0/API/assignmentRule	Update
DELETE	/core/1.0/API/assignmentRule/:id	Delete
POST	/core/1.0/API/ assignmentRules	Get all rules in work set
POST	/core/1.0/API/assignmentRule/:id	Get rule details

For the create and update API’s, the body fields are needed to provide the necessary context. A list of these fields and which call they are required for is provided below.

Field	Type	Values	Description	Mandatory
entity.id	String	Any	Rule Id	Yes [update]
entity.step	Object	-	Step target	Yes [create]
entity.step.name	String	Any	Step name	Yes [create]
entity.step.version	String	Any	Step version	Yes [create]
entity.attribute	String	Any	Attribute name	Yes [create]
entity.operands	Array	-	Operands array	Yes [create]
entity.operands[].operator	String	ASSIGN, ADD, SUBTRACT, MULTIPLY, DIVIDE, POWER, SQUARE, PERCENTAGE, ROUND	Operator	No [ASSIGN by default]
entity.operands[].function	String	ASSIGN, FORMAT	Function	No [ASSIGN by default]
entity.operands[].value	String or Object	-	Can be string or reference to step target/data view	Yes
entity.operands[].value.name	String	Any	Step target/data view name	Yes
entity.operands[].value.version	String	Any	Step target/data view version	Yes
entity.operands[].value.attribute	String	Any	Step target/data view attribute name	Yes
entity.conditions	Array	-	Conditions array for the rule	No
entity.conditions[].operator	String	EQUAL, NOT_EQL, GREATER, LESSER, GREAT_EQL, LESS_EQL	Operator	No [EQUAL by default]
entity.conditions[].value	String	Any	Comparison element	Yes
entity.conditions[].operand	Object	-	Reference element	Yes
entity.conditions[].operand.name	String	Any	Step target/data view name	Yes
entity.conditions [].operand.version	String	Any	Step target/data view version	Yes
entity.conditions [].operand.attribute	String	Any	Step target/data view attribute name	Yes