Get Job Status

Get Job Status

Get the status of one job.

Request
URI
GET
https://{api_host}/dms/data-consumer/v0alpha1/info-jobs/{job_id}/status
COPY
Path Parameters
string
job_id
Required

The identifier for one job.

Responses
200

Successful retrieval of the status of the identified job.

Returns ConsumerJobStatus of type(s) application/json 
{
    "info_job_status": "string",
    "producers": [
        "pmhistory"
    ]
}
string
info_job_status
Required

Whether the job can currently be satisfied. The status is 'ENABLED' if there is at least one producer of the required data type, 'DISABLED' otherwise.

Possible values are : ENABLED, DISABLED,
array of string
producers
Required

An array of all registered producers of the relevant data type.


404

Unable to retrieve job status: job does not exist.

Returns ProblemDetails of type(s) application/problem+json 
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


On This Page
Data Consumer Operations
DELETE
Delete Individual Job
DELETE
Delete Info Type Subscription
GET
Get Individual Job
GET
Get Info Type Consumer
GET
Get Info Type Subscription
GET
Get Info Type Subscriptions
GET
Get Job Ids
GET
Get Job Results
GET
Get Job Status
GET
List Info Types Consumer
PUT
Put Individual Info Job
PUT
Put Info Type Subscription