[{"label":"Latest (0.1.1)","version":"latest"}]
cric-r1

Get Individual Job

Description

Retrieve details of one data job.

Request

Request

URL

URL


get
https://{api_host}/dms/data-consumer/v0alpha1/info-jobs/{job_id}
Copy

Path Parameters

Path Parameters

string
job_id Required

The identifier for one job.


Response

Response

Response Body

Response Body

200 OK returns ConsumerJob of type application/json

Successful retrieval of details of one data job.

{
	"info_type_id": "pmhistory",
	"job_definition": {},
	"job_owner": "pmhistory-consumer",
	"job_result_uri": "http://pmhistory-consumer:8000/v0alpha1/jobs/53196a4b-6b1b-4284-9213-dd8f36d88537",
	"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.


object
job_definition Required

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


string
job_owner Required

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


string
job_result_uri Required

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


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.

Errors

Errors

404

The data job identified by job_id cannot be found.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/dms/data-consumer/v0alpha1/info-jobs/{job_id}


Feedback

Was this page helpful?