Notify Job Results

Notify Job Results

This is the callback URI that a data producer invokes when the results of a data-collection job are ready for retrieval.

Request
URI
POST
https://{api_host}/dms/v0alpha1/job_results/{job_id}
COPY
Path Parameters
string
job_id
Required

The unique identifier for one job that the dms has created and is awaiting results.

Request Body

JSON object that provides the callback URI to fetch the data for collection.

JobResultCallbackResponse of type(s) application/json
Required 
{
    "data": {
        "uri": "http://pmhistory:8080/v0alpha1/jobs/b66d0144-2137-11ec-8e85-f3c25b763afb",
        "type": "application/json;stream=true",
        "data_type": "pmhistory"
    }
}
DataInfo
data
Required

data

Responses
204

The incoming job results notification was successfully decoded and the results retrieved.

Operation doesn't return any data structure

400

The incoming job results notification could not be decoded.

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.


On This Page
Data Producer Operations
POST
Notify Job Results