Get Info Type Consumer

Retrieve the details of one data-type including if the data-type has active producers, the number of producers, the schema for producing requests using this data type, and additional type information.

Request

URI

GET

https://{api_host}/dms/data-consumer/v0alpha1/info-types/{info_type_id}

COPY

Path Parameters

string

info_type_id

Required

The name of one data type.

Responses

200

Details of one data type.

Returns DataTypeInformation of type(s) application/json

{
    "no_of_producers": 1,
    "type_status": "ENABLED",
    "job_data_schema": {
        "required": [
            "start",
            "end",
            "technology"
        ],
        "type": "object",
        "description": "The filtering parameters that shape a pmhistory query. `start`,\n`end`, `technology` and `counter_names` are required. If one or\nmore `cell_ids` or `vector_indexes` are provided, the results\nare filtered by those ids and indexes. If a chosen counter\nis a vector and no `vector_indexes` value is provided, then the\ncaller is responsible for processing the vectors appropriately.\nIf any `vector_indexes` are present then `counter_names` must\nhave only one item. **Note**: This format is expected to change\nas R1 standards mature.\n",
        "properties": {
            "start": {
                "type": "integer",
                "description": "Milliseconds since the UNIX epoch defining the start of the time range to query.\n",
                "examples": [
                    1632781620000
                ]
            },
            "end": {
                "type": "integer",
                "description": "Milliseconds since the UNIX epoch defining the end of the time range to query.\n",
                "examples": [
                    1632929865000
                ]
            },
            "technology": {
                "type": "string",
                "description": "The wireless networking technology, `nr` or `lte`, of the counters being retrieved.\n",
                "enum": [
                    "nr",
                    "lte"
                ]
            },
            "cell_ids": {
                "type": "array",
                "description": "A list of Cell Global Identifiers. The results are filtered\nto include only data for the listed cells. If this\nfield is not present, then the results contain counter\ndata for all cells for all provided counter names.\n",
                "items": {
                    "type": "string",
                    "description": "One cell global identifier as a string."
                },
                "examples": [
                    [
                        "14342903"
                    ]
                ],
                "minItems": 1
            },
            "counter_names": {
                "type": "array",
                "description": "One or more counter names on which to filter the results.\n",
                "items": {
                    "type": "string",
                    "description": "One counter name."
                },
                "minItems": 1,
                "examples": [
                    [
                        "PMUECTXTSETUPATT"
                    ]
                ]
            },
            "vector_indexes": {
                "type": "array",
                "description": "One or more vector indexes on which to filter the results. If this is set then `counter_names` must have a length of 1 and it is that counter's vectors that will be filtered.\n",
                "items": {
                    "type": "integer",
                    "description": "One vector index.",
                    "minimum": 0,
                    "maximum": 255,
                    "examples": [
                        5
                    ]
                },
                "examples": [
                    [
                        5
                    ]
                ],
                "minItems": 1
            },
            "type_information": {
                "type": "object",
                "description": "Additional information about the type"
            }
        }
    }
}

integer

no_of_producers

Required

The number of registered producers for this type.

string

type_status

Required

Allowed values:

ENABLED: one or more producers for the data type are operational.
DISABLED: no producers for the datatype are operational.

Possible values are : ENABLED, DISABLED,

object

job_data_schema

Required

JSON schema for the job data

404

The data type identified by info_type_id cannot be found.

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

Description

Request

Path Parameters

Response

200 Response Body

Errors

Data Consumer Operations

DELETE

Delete Individual Job

DELETE

Delete Info Type Subscription

GET

Get Individual Job

GET

Get Info Type Consumer

GET

Get Info Type Subscription

GET

Get Info Type Subscriptions

List Info Types Consumer

PUT

Put Individual Info Job

PUT

Put Info Type Subscription