Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Purpose

...

Get the processing status of the async job.

Specification

...

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/encounter-data-package/get-async-job-processing-details

Resource

/api/jobs/{{id}}

Scope

job:read

Components

API paragraph not found

Microservices

API paragraph not found

Protocol type

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

Request data validation

...

API paragraph not found

Processing

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
titleResponse 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
titleResponse 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

...