Purpose

This WS allows to get list of rule engine rules without rules details. Used to get by id, name or code of the rule engine rule.

Key points

1. This is a REST method used by MIS.

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

Specification

Logic

1. Filter rule_engine_rules

   1. with is_active=true status

   2. by search params

2. Render a response according to specification.

Request structure

See on Apiary

Filters

Authorize

• 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”)

Headers

Content-Type:application/json

Request data validation

Processing

Search params

1. name. Search by rule_engine_rules.name

2. code. Searches by rule_engine_rules.code.code

3. system. Searches by rule_engine_rules.code.system

Response structure

See on Apiary

{
  "data": [
    {
      "id": "1f8444a0-e48b-440b-a082-c4703233efa2",
      "name": "Some name",
      "code": {
        "system": "eHealth/clinical_impression_patient_categories",
        "code": "insulin_1"
      }
    }
  ],
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Post-processing processes

HTTP status codes