Create Job

Create Job

This is the interface used by the data management service to instantiate a job, do not use directly.

Request
URI
POST
https://{api_host}/v0alpha1/jobs
COPY
Request Body

The job information. The format is made up of several fields required by R1 data management, plus an info_job_data field that is specific to the type of job being created. In this case a cmread, cmwrite, or cmtrack job.

producer_info_job_request of type(s) application/json
Optional
{
    "owner": "string",
    "last_updated": "string",
    "info_job_identity": "94ec9a62-213b-11ec-af33-7f567fdd0e71",
    "target_uri": "http://consumer:8080/v0alpha1/jobs_results/94ec9a62-213b-11ec-af33-7f567fdd0e71",
    "info_type_identity": "cmwrite",
    "status": 0
}
string
owner
Optional

The owner of the job, usually the name of rApp that created the job.

string
last_updated
Optional

The time when the job was last updated or created (ISO-8601).

string As uuid As uuid
info_job_identity
Required

The identifier for the job, usually a UUID.

string
target_uri
Required

URI to which the produced information is sent. This can be actual results, or in the case of cmwrite a notification of where to retrieve the results.

info_job_data
Required

info_job_data

string
info_type_identity
Optional

Identifier of the data or information type used for the job.

integer
status
Optional

An integer value representing the status of the job.

Responses
200

An empty response indicating the job was successfully created. It will be processed asynchronously.

Operation doesn't return any data structure

400

The request is of the correct content-type but is incorrectly formed in some fashion: missing required fields, using wrong types for valid fields, or not capable of being processed as the expected input.

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.