Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Data Model

LookupRuleProperty Object

Field	Mandatory	Type	Default Value	Description
name	Yes	String	-	The name of the property.
values	Yes	List	-	List of comma-separated values for the property.

The object represents the existing Everbridge group. The information of the group can be accessed via Groups public API or from the Manager Portal.

Field	Mandatory	Type	Default Value	Description
id	Yes	Long	-	Everbridge group ID.
name	Yes	String	-	The name of the Everbridge group.

Field	Mandatory	Type	Default Value	Description
id	Yes	String	-	(System-Generated) The ID of the property.
organizationId	Yes	Long	-	The ID of the organization containing groups.
name	Yes	String	-	The name of the attribute.
values	Yes	List	-	List of comma-separated values for the property.
createdBy	No	String	0	The name of the person who created this property.
lastUpdatedBy	No	String	-	The name of the person who most recently updated this property.
lastUpdatedOn	No	date	-	The time of the most recent update.

Field	Mandatory	Type	Default Value	Description
id	Yes	String	-	(System-Generated) The ID of the mapping.
organizationId	Yes	Long	-	The ID of the organization containing groups.
deleted	No	boolean	false	The property indicates the mapping is deleted.
targetGroups	Yes	List	-	List of Group objects.
attributes	Yes	List	-	List of LookupRuleProperty objects, each defining property containing name and values.
createdBy	No	String	-	The name of the person who created this mapping.
lastUpdatedBy	No	String	-	The name of the person who most recently updated this mapping.
lastUpdatedOn	No	date	-	The time of the most recent update.