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. |
action | String | Rule action: include or exclude. |
target | String | Target entity type: people, courses, sections, schools. |
conditions | Array | Logical conditions matching attributes against values. |
integration_id | UUID | Integration ID to which this rule applies. |
JSON Example
{
"id": "7ca194a2-1982-4f91-8841-59128aa10234",
"name": "Only High School Students",
"action": "include",
"target": "people",
"conditions": [
{
"field": "grade_level",
"operator": "in",
"value": ["9", "10", "11", "12"]
}
],
"integration_id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92"
}