Get Rule engine rule details_EN

Purpose

This WS is designed to return rule engine rule details.

Key points

1. This is a REST method used by MIS.

2. Only authenticated and authorized employee with appropriate scope can get rule engine rule details.

Specification

Apiary

Validations

Authorization

• Verify the validity of the access token

  • in case of error - return 401 (“Invalid access token”)

• Verify that token is not expired

  • in case of error - return 401 (“Invalid access token”)

• Check user scopes in order to perform this action (scope = 'rule_engine_rule:read')

  • in case of invalid scope(s) - return 403 (“Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read”)

Validate rule engine rule

1. Check that rule engine rule with such ID exists in the system (is_active = true)

   1. In case of error - return 404 "Rule with id <rule_id> is not found", where rule_id - id of rule from request

Search params

• id

Service logic

1. Get data from rule_engine_rules collection (Mongo DB):

   1. rule_engine_rule by id

2. Render a response according to specification.