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

Put Individual Info Job

Description

Create a new data job for the provided data type. If that data type is not yet being produced, the job will not be enabled until a producer becomes available.

Request

Request

URL

URL


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


Query Parameters

Query Parameters

boolean
type_check Optional

When ‘type_check’ is true, the job will be checked to make sure the chosen data type exists and the provided job matches the data type’s schema.

Parameter Serialization Style: form Explode:true

Request Body

Request Body

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

Response

Response

200 OK

Job successfully updated.

Errors

Errors

400

Job not created or updated, request body malformed.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"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"}' https://{api_host}/dms/data-consumer/v0alpha1/info-jobs/{job_id}


Feedback

Was this page helpful?