Post /dataregistration/v1 /rapps/ {rapp Id} /datatypeprodcaps

Post /dataregistration/v1 /rapps/ {rapp Id} /datatypeprodcaps

Register DME type production capabilities of a producing rApp. If the DME type is being registered for the first time (system-wide) then this registration makes the type discoverable.

Request
URI
POST
https://{api_host}/dms/dataregistration/v1/rapps/{rappId}/datatypeprodcaps
COPY
Path Parameters
string
rappId
Required

Identifier of the producing rApp.

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.

Request Body
DmeTypeProdCapRegistration of type(s) application/json
Required 
{
    "dataTypeInformation": {
        "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
                }
            }
        ]
    },
    "dataRequestEndpoint": {
        "ipv4Addr": "string",
        "ipv6Addr": "string",
        "fqdn": "string",
        "port": 0,
        "apiPrefix": "string",
        "securityMethods": [
            {}
        ]
    },
    "dataSubscriptionEndpoint": {
        "ipv4Addr": "string",
        "ipv6Addr": "string",
        "fqdn": "string",
        "port": 0,
        "apiPrefix": "string",
        "securityMethods": [
            {}
        ]
    }
}
DmeTypeInformation
dataTypeInformation
Required

dataTypeInformation

object
dataProducerConstraints
Optional

Formulates producer constraints related to the DME type based on the dataProductionSchema

InterfaceDescription
dataRequestEndpoint
Optional

dataRequestEndpoint

InterfaceDescription
dataSubscriptionEndpoint
Optional

dataSubscriptionEndpoint

Responses
201

DME type production capabilities successfully registered.

Returns DmeTypeProdCapRegistration of type(s) application/json 
{
    "dataTypeInformation": {
        "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
                }
            }
        ]
    },
    "dataRequestEndpoint": {
        "ipv4Addr": "string",
        "ipv6Addr": "string",
        "fqdn": "string",
        "port": 0,
        "apiPrefix": "string",
        "securityMethods": [
            {}
        ]
    },
    "dataSubscriptionEndpoint": {
        "ipv4Addr": "string",
        "ipv6Addr": "string",
        "fqdn": "string",
        "port": 0,
        "apiPrefix": "string",
        "securityMethods": [
            {}
        ]
    }
}
DmeTypeInformation
dataTypeInformation
Required

dataTypeInformation

object
dataProducerConstraints
Optional

Formulates producer constraints related to the DME type based on the dataProductionSchema

InterfaceDescription
dataRequestEndpoint
Optional

dataRequestEndpoint

InterfaceDescription
dataSubscriptionEndpoint
Optional

dataSubscriptionEndpoint

Response Headers

string
Location

Contains the URI of the newly created resource

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.


409
Returns Conflict 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.


415
Returns Unsupported 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
Data Registration Operations
POST
Post /dataregistration/v1 /rapps/ {rapp Id} /datatypeprodcaps