Create Job

Create Job

This is the interface used solely by data management (DMS) to instantiate a job.

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 data-type of the job being created. In this case a pmhistory job.

producer_info_job_request of type(s) application/json
Optional 
{
    "owner": "energy-saving",
    "last_updated": "string",
    "info_job_identity": "94ec9a62-213b-11ec-af33-7f567fdd0e71",
    "target_uri": "http://pmhistory-consumer:8080/v0alpha1/jobs_results/94ec9a62-213b-11ec-af33-7f567fdd0e71",
    "info_job_data": {
        "start": 1632781620000,
        "end": 1632929865000,
        "technology": "string",
        "cell_ids": [
            "3139998247308295"
        ],
        "counter_names": [
            "PMUECTXTSETUPATT"
        ]
    },
    "info_type_identity": "pmhistory"
}
string
owner
Optional

The identifier for the rApp that made the job request.

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 unique identifier for the job provided in the job request. A uuid.

string
target_uri
Required

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

pmhistory_job_data
info_job_data
Required

info_job_data

string
info_type_identity
Optional

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

Responses
200

The job was successfully created.

Operation doesn't return any data structure

400
Returns 400BadRequest 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.


On This Page
Job Handling Operations
POST
Create Job
DELETE
Delete Job
GET
Get Job Results