Get Datadiscovery

Get Datadiscovery

Discover the DME types that are present in the R1 environment.

Request
URI
GET
https://{api_host}/dms/datadiscovery/v1/datatypes
COPY
Path Parameters
datatypeId
datatypeId
Required

datatypeId

Header Parameters
string
Version
Optional

If provided in a request, the value of the header is a string signalling the desired version of the API to be used in handling the request. If the provided version is not available, a 406 Not Acceptable response will be sent. If no Version header is provided, the latest available version will be used. This mechanism allows a user-agent to request a specfic version of the API when multiple versions are available.

Responses
200

The response body contains the result of the search over the list of registered DME Types

Returns DmeTypeInformation of type(s) application/json 
{
    "dataTypeId": {
        "namespace": "string",
        "name": "string",
        "version": "string"
    },
    "metadata": {
        "dataCategory": [
            "string"
        ],
        "rat": [
            "string"
        ]
    },
    "dataDeliverySchemas": [
        {
            "type": "string",
            "deliverySchemaId": "string",
            "schema": "string"
        }
    ],
    "dataDeliveryMechanisms": [
        {
            "deliveryMethod": "string",
            "kafkaDeliveryConfiguration": {
                "numPartitions": 0,
                "cleanUpPolicy": "string",
                "compressionType": "string",
                "retentionBytes": 0,
                "retentionMs": 0
            }
        }
    ]
}
DmeTypeIdStruct
dataTypeId
Required

dataTypeId

Metadata
metadata
Required

metadata

object
dataProductionSchema
Optional

Schema that defines the information necessary to formulate a data request or data subscription. If this attribute is not present, the schema is assumed to be known from the DME type definition that is referenced by dataTypeId.

array of DeliverySchema
dataDeliverySchemas
Required

List of delivery schemas supported by the producer for the DME type being registered.

array of DataDeliveryMechanism
dataDeliveryMechanisms
Required

Defines the delivery mechanism supported by Data Producer.

Response Headers

string
Version

The Version header in a response indicates the version of the API used to handle this request-response pair, in an API which has the potential to support multiple versions. Different versions may be requested using a Version header in a request.


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


401
Returns Unauthorized 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.


403
Returns Forbidden 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.


404
Returns NotFound 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.


406
Returns Unacceptable 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
Returns ServerError 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.


503
Returns ServiceUnavailable 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
Datadiscovery Operations
GET
Get Datadiscovery
GET
Get Datadiscovery