...
| 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 async Job processing details [API-012-001-004-0416] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-012-001-004-0416 |
|---|
Microservices (namespace) | UA ADRESSES |
|---|
Component | Dictionaries and Registers |
|---|
Component ID | COM-012-001 |
|---|
Link на API-специфікацію | https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/encounter-data-package/get-async-job-processing-details |
|---|
Resource | {{host}}/api/jobs/{{id}} |
|---|
Scope | job:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
Get the processing status of the async job.
Logic
This resource should be used to get the processing status of the async job.
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | id | | String | request identifier | NBXk9EyErUZv1RhXgyvgg
|
| 2 | | | | | |
Request structure
See on API-specification
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Processing
N/A
Response structure examples
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| {
"data": {
"status": "pending",
"eta": "2018-08-02T10:45:16.000Z",
"links": [
{
"entity": "job",
"href": "/Jobs/NBXk9EyErUZv1RhXgyvgg"
}
]
},
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
}
} |
|
...
| Expand |
|---|
|
| Code Block |
|---|
| {
"data": {
"status": "failed",
"status_code": "422",
"error": {
"type": "validation_failed",
"message": "Validation failed. You can find validators description at our API Manifest: http://docs.apimanifest.apiary.io/#introduction/interacting",
"invalid": [
{
"entry_type": "json_data_proprty",
"entry": "$.cvv",
"rules": [
{
"rule": "required",
"params": [],
"description": "must be present"
}
]
}
]
},
"eta": "2019-04-26T09:16:15.936"
},
"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 | Response | | |
| 3 | Специфічні |
| 4 | | | | | |
Post-processing processes
N/A
Technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...