Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose

...

Get the processing status of the async job.

Specification

...

Page Properties
Project Name
COVID-certificate
Project abreviation
SVC
Developer
Розробник методу API. Наприклад, Edenlab
Project Manager
@Єлизавета Гессен-Дармштадська
Tech Lead
@Іоанн Воїнов
Product Owner
@Нікодім Святогорцев
Вusiness analyst
@Пантелеймон Нікомедійський
Status
Status
colour Green
title APPROVED
Version
1.0
Date of release
22 Jun 2022
Link
https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/encounter-data-package/get-async-job-processing-details
Resource
/api/jobs/{{id}}
Scope
job:read
Components
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionAPI paragraph not found
Microservices
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
Request type
GET
Sync/Async
Метод є синхронним чи асинхронним?
...
API paragraph not found
Public/Private/Internal
Public

Logic

This resource should be used to get the processing status of the async job.

Input parameters

Input parameter	Values	Type	Description	Example
id		String	request identifier	`NBXk9EyErUZv1RhXgyvgg`

Request structure

...

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:
Content-Type:application/json
Authorization:Bearer 342432fdsfdsgfdt24535422fgds
...
API paragraph not found

Request data validation

...

API paragraph not found

Processing

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand

title	Response example

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

title	Response example

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"
  }
}

Post-processing processes

...

API paragraph not found

HTTP status codes

...

HTTP status code
Message
What caused the error
200

303
403
404
409
422

Page Properties
Project Name	COVID-certificate
Project abreviation	SVC
Developer	Розробник методу API. Наприклад, Edenlab
Project Manager	@Єлизавета Гессен-Дармштадська
Tech Lead	@Іоанн Воїнов
Product Owner	@Нікодім Святогорцев
Вusiness analyst	@Пантелеймон Нікомедійський
Status

Link	https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/encounter-data-package/get-async-job-processing-details
Resource	/api/jobs/{{id}}
Scope	job:read
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionAPI paragraph not found
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET
Sync/Async	Метод є синхронним чи асинхронним?

Versions Compared

Old Version 1

New Version Current

Key

Required parameters are marked with "*"

Purpose

Get the processing status of the async job.

Specification

Logic

Input parameters

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:
Content-Type:application/json
Authorization:Bearer 342432fdsfdsgfdt24535422fgds
...
API paragraph not found

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code
Message
What caused the error
200

303
403
404
409
422

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Required parameters are marked with "*"

Purpose

Get the processing status of the async job.

Specification

Logic

Input parameters

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:Content-Type:application/jsonAuthorization:Bearer 342432fdsfdsgfdt24535422fgds...API paragraph not found

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status codeMessageWhat caused the error 200 303403404409422

Наприклад:
Content-Type:application/json
Authorization:Bearer 342432fdsfdsgfdt24535422fgds
...
API paragraph not found

HTTP status code
Message
What caused the error
200

303
403
404
409
422