Get Rule Set Documentation

GET/rule-sets/{ruleSetId}

Required Tokens

Field	Type	Required	Description
Bearer	Authorization: Bearer <api-key>	Optional	Your API key. Pass it as the Bearer token on every request.
Event token	x-Event-Token	Optional	Run Get Tokens in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Returns one rule set with its rules, thresholds and reset conditions.

Requires EventBasicAccess permission on the event.

Event scoping: This endpoint does not include {eventId} in the URL. The event is determined automatically from your x-Event-Token.

Field	Type	Required	Description
ruleSetId	Guid	Required	The rule set.

Field	Type	Description
id	Guid	The rule set.
name	string	Name.
resourceTypeIds	Guid[]	Types that use it by default.
rules	array	`{ id, name, description, priority, isActive, conditionType, trackedBlockType: { id, name }, windowStart, windowEnd, resultingStateId, daysOfWeek[], annualDates[], thresholds[], resetConditions[] }`.
rules[].annualDates	string[]	Annual dates, `MM-DD` or `MM-{1\
rules[].thresholds	array	`{ id, order, threshold, thresholdUnit, operator, resultingState: { id, name } }`.
rules[].resetConditions	array	`{ id, resetType, blockType: { id, name }, minDuration, durationUnit, period, periodStartDay, thresholdOverrides: [{ ruleThresholdId, threshold, thresholdUnit }] }`.

HTTP Status	Description
404	Rule set not found.