Put Individual Info Job

Put Individual Info Job

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. If the data type does not exist, the job will be rejected with a 400 response.

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

The identifier for one job.

Query Parameters
boolean
type_check
Optional

When 'type_check' is true, the job will be checked to make sure there is an active producer for the chosen data type. If there is not, the job will be rejected with a 400 response.


Request Body
ConsumerJob of type(s) application/json
Required
{
    "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.

Responses
200

Job successfully updated.

Operation doesn't return any data structure

201

Job successfully created.

Operation doesn't return any data structure

400

Job not created or updated, request body malformed.

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.


500

Processing job failed due to server misconfiguration.

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.