Versions Compared

Old Version 6

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методуDRAFT] Get Rule engine rule list [API-005-005-001-0085]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-005-001-0085

Microservices (namespace)

IL

Component

Dictionaries and Registers

Component ID

COM-005-005

Link на API-специфікацію

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/rule-engine-rules/get-rule-engine-rule-list/get-rule-engine-rule-list

Resource

{{host}}/api/rule_engine_rules

Scope

rule_engine_rule:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

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.

Logic

  1. Filter rule_engine_rules

    1. with is_active=true status

    2. by search params

  2. Render a response according to specification.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in ConfluenceN/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

 

 

 

 

 

Request structure

See on API-specification

Expand
titleExample
Code Block
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
 
...
 
...
 
...
 
...
 
Headers 
Request data validation
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”)
Processing
  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 examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "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"
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200 
3
401
Invalid access token
4
403
Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read
5
Специфічні
6
 
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Название
ID ТМ
Статус
/wiki/spaces/ESOZ/pages/17378181218
TM0112
/wiki/spaces/YK/pages/17837688354
...