For Developers
Rules Overview
An Integration Rule controls what educational data is shared through an integration. Rules evaluate conditions against schools, courses, sections, and user demographics to include or exclude matching records.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the rule. |
created_date | Date | Date when the rule was created. |
updated_date | Date | Last modification date. |
name | String | Descriptive name for the rule. |
state | String | Rule state: draft, suggested, or active. |
type | String | Rule type: sharing or licensing. |
target | String | Target entity type: people, classes, schools, or enrollments. |
conditions | Array | Conditions. Each one has target, property, operator, and values. |
integration_id | UUID | Integration ID to which this rule applies. |
JSON Example
{
"id": "7ca194a2-1982-4f91-8841-59128aa10234",
"name": "Only High School Students",
"state": "active",
"type": "sharing",
"target": "people",
"conditions": [
{
"target": "person",
"property": "grade_levels",
"operator": "IN",
"values": ["09", "10", "11", "12"]
}
],
"integration_id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92"
}
