Create Event Subscription

Create Event Subscription

Creates a new individual CAPIF Event Subscription.

Request
URI
POST
https://{api_host}/dms/capif-events/v1/{subscriberId}/subscriptions
COPY
Path Parameters
string
subscriberId
Required

Identifier of the Subscriber

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
EventSubscription of type(s) application/json
Required 
{
    "events": [
        "string"
    ],
    "eventFilters": [
        {
            "apiIds": [
                "string"
            ],
            "apiInvokerIds": [
                "string"
            ],
            "aefIds": [
                "string"
            ]
        }
    ],
    "eventReq": {
        "immRep": false,
        "maxReportNbr": 0,
        "monDur": "string",
        "repPeriod": 0,
        "grpRepTime": 0
    },
    "notificationDestination": "string",
    "requestTestNotification": false,
    "websockNotifConfig": {
        "websocketUri": "string",
        "requestWebsocketUri": false
    },
    "supportedFeatures": "string"
}
array of CAPIFEvent
events
Required

Subscribed events

array of CAPIFEventFilter
eventFilters
Optional

Subscribed event filters

ReportingInformation
eventReq
Optional

eventReq

Uri
notificationDestination
Required

notificationDestination

boolean
requestTestNotification
Optional

Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise.

WebsockNotifConfig
websockNotifConfig
Optional

websockNotifConfig

SupportedFeatures
supportedFeatures
Optional

supportedFeatures

Responses
201

Created (Successful creation of subscription)

Returns EventSubscription of type(s) application/json 
{
    "events": [
        "string"
    ],
    "eventFilters": [
        {
            "apiIds": [
                "string"
            ],
            "apiInvokerIds": [
                "string"
            ],
            "aefIds": [
                "string"
            ]
        }
    ],
    "eventReq": {
        "immRep": false,
        "maxReportNbr": 0,
        "monDur": "string",
        "repPeriod": 0,
        "grpRepTime": 0
    },
    "notificationDestination": "string",
    "requestTestNotification": false,
    "websockNotifConfig": {
        "websocketUri": "string",
        "requestWebsocketUri": false
    },
    "supportedFeatures": "string"
}
array of CAPIFEvent
events
Required

Subscribed events

array of CAPIFEventFilter
eventFilters
Optional

Subscribed event filters

ReportingInformation
eventReq
Optional

eventReq

Uri
notificationDestination
Required

notificationDestination

boolean
requestTestNotification
Optional

Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise.

WebsockNotifConfig
websockNotifConfig
Optional

websockNotifConfig

SupportedFeatures
supportedFeatures
Optional

supportedFeatures

Response Headers

string
Location

Contains the URI of the newly created resource, according to the structure {apiRoot}/capif-events/v1/{subscriberId}/subscriptions/{subscriptionId}

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
Event Subscription Management Operations
POST
Create Event Subscription
DELETE
Delete Event Subscription