Get Job Results

Get Job Results

Get the results of one job. For notification-style data management interactions the URI is a one-use URI for retrieving the job results and is the only URL that a consumer should use when interacting with this service.

For other interaction styles the URI may allow multiple uses.

Request
URI
GET
https://{api_host}/v0alpha1/jobs/{job_id}
COPY
Path Parameters
string
job_id
Required

The unique identifier for one job result.

Responses
200

A successful retrieval of one job result, presented as a transfer-encoding chunked stream of multiple JSON objects, each single object as described in the schema.

Returns job_result of type(s) application/json;stream=true 
{
    "epoch_timestamp_ms": 1632781620000,
    "counter_name": "PMRRCCONNESTABATT",
    "counter_value": 5,
    "vector_index": 0,
    "cell_global_id": "string",
    "cell_relation": 0,
    "arp": 0,
    "beam_id": 0,
    "qci_5qi": 0,
    "slice_id": 0,
    "cause": "string"
}
integer As int64 As int64
epoch_timestamp_ms
Optional

Time in milliseconds since the UNIX epoch that this counter was recorded.

string
counter_name
Optional

The name of the PM counter, as stored in the PM History database.

number As float As float
counter_value
Optional

The float value of the counter at the time indicated by epoch_timestamp_ms.

integer As int64 As int64
vector_index
Optional

The vector index of this counter, if any. Set to -1 if this is a scalar counter.

string
cell_global_id
Optional

The identifier of a cell. This is a Cell Global ID as a sequence of numerals as a string.

integer As int64 As int64
cell_relation
Optional

Indicates the other cell in cell relation PM counters.

integer As int32 As int32
arp
Optional

The arp of this counter, if any.

integer As int32 As int32
beam_id
Optional

The beam id of this counter, if any.

integer As int32 As int32
qci_5qi
Optional

The qci_5qi of this counter, if any.

integer As int64 As int64
slice_id
Optional

The slice id of this counter, if any.

string
cause
Optional

The cause of this counter, if any.

Response Headers

string
transfer-encoding

The `transfer-encoding` header identifies that this response is using chunked encoding and may be treated as a stream.


404

Results for the identified job do not exist.

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

There was an unexpected system error retrieving data. The most common cause is the data-persistence layer being unavailable.

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
Job Handling Operations
POST
Create Job
DELETE
Delete Job
GET
Get Job Results