| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [DRAFT] REST API Get events list [API-003-001-001-0012] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-003-001-001-0012 |
|---|
Microservices (namespace) | EM |
|---|
Component | Event manager |
|---|
Component ID | COM-003-001 |
|---|
Link на API-специфікацію | https://ehealthmisapi1.docs.apiary.io/#reference/public.-event-manager/get-events-list/get-events-list |
|---|
Resource | {{host}}/api/events |
|---|
Scope | event:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
This method is used to obtain list of events with filters
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | | | | | |
| 2 | | | | | |
Request structure
See on API-specification
Headers
Request data validation
N/A
Processing
N/A
Response structure examples
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| {
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": [
{
"id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"event_type": "StatusChangeEvent",
"entity_type": "MedicationDispense",
"entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"properties": {
"status": {
"new_value": "COMPLETED"
},
"employee_id": {
"new_value": "e1453f4c-1077-4e85-8c98-c13ffca0063e"
}
},
"event_time": "2017-04-20T19:14:13Z",
"changed_by": "df9f70ee-4b12-4740-b0f5-bb5aea116863"
}
],
"paging": {
"page_number": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 23
}
} |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | Response | | |
| 3 | Специфічні |
| 4 | | | | | |
Post-processing processes
N/A
Technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|