Get Individual Job

Get Individual Job

Retrieve details of one data job.

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

The identifier for one job.


Responses
200

Successful retrieval of details of one data job.

Returns ConsumerJob of type(s) application/json
{
    "info_type_id": "pmhistory",
    "job_result_uri": "http://pmhistory-consumer:8000/v0alpha1/jobs/53196a4b-6b1b-4284-9213-dd8f36d88537",
    "job_owner": "pmhistory-consumer",
    "status_notification_uri": "http://pmhistory-consumer:8000/v0alpha1/jobs/53196a4b-6b1b-4284-9213-dd8f36d88537/status"
}
string
info_type_id
Required

The identifier of the data type that this job is consuming.

string
job_result_uri
Required

The target URI to which the DMS will post job results when they are ready.

string
job_owner
Required

The identifier of the owner of the job. Generally this is the consumer itself.

object
job_definition
Required

A job definition matching the schema associated with the chosen data type.

string
status_notification_uri
Optional

An optional notification URI to which the DMS may post status updates if the job goes from an enabled to disabled state, or vice versa.


404

The data job identified by job_id cannot be found.

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.