Purpose

Get the processing status of the async job.

Specification

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

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Response example

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

Response example

{
  "data": {
    "status": "processed",
    "eta": "2018-08-02T10:45:16.000Z",
    "links": [
      {
        "entity": "encounter",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/encounters/90a9e15b-b71b-4caf-8f2e-ff247e8a5600"
      },
      {
        "entity": "condition",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/conditions/df112200-64da-451b-bf77-8e7655bbd48f"
      },
      {
        "entity": "observation",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/observations/d118cc02-3b9b-4d1a-b728-eda4e3d58f25"
      },
      {
        "entity": "allergy_intolerance",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/allergy_intolerances/5f41c64a-6742-4d6d-9f3b-c6742b2ee0a1"
      },
      {
        "entity": "immunization",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/immunizations/12e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      },
      {
        "entity": "risk_assessment",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/risk_assessments/22e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      },
      {
        "entity": "device",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/devices/32e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      },
      {
        "entity": "medication_statemet",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/medication_statemets/42e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      },
      {
        "entity": "medication_administration",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/medication_administration/42e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      },
      {
        "entity": "diagnostic_report",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/diagnostic_reports/42e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      },
      {
        "entity": "procedure",
        "href": "{host}/api/patients/3da18c10-d2ca-469e-bde5-7413201cea2/procedure/42e5985d-2a79-452f-8bc4-ed3a02fdefc5"
      }
    ],
    "status_code": "200"
  },
  "meta": {
    "code": 303,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Response example

{
  "data": {
    "error": "Error description",
    "eta": "2018-08-02T10:45:16.000Z",
    "status": "failed",
    "status_code": "403"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Response example

{
  "data": {
    "error": "Error description",
    "eta": "2018-08-02T10:45:16.000Z",
    "status": "failed",
    "status_code": "404"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Response example

{
  "data": {
    "error": {
      "message": "Error description",
      "type": "Error_type"
    },
    "eta": "2018-08-02T10:45:16.000Z",
    "status": "failed",
    "status_code": "409"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Response example

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

Get async Job processing details

Purpose

Specification

Logic

Input parameters

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes