REST API method / Метод REST API (настанова) (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 методу] |
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-0086 |
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-details/get-rule-engine-rule-details |
Resource | {{host}}/api/rule_engine_rules/{{id}} |
Scope | rule_engine_rule:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Get data from rule_engine_rules collection (Mongo DB):
rule_engine_rule by id
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 Confluence
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String |
|
|
| 2 |
|
|
|
|
|
...
Check that rule engine rule with such ID exists in the system (is_active = true)
In case of error - return 404 "Rule with id <rule_id> is not found", where rule_id - id of rule from request
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...