Register Subscription

Register Subscription

Registers Subscription. Only Solution users and system admin (e.g. for vRO) can manage subscriptions.

Request
URI
POST
https://{api_host}/event-broker-service/api/subscriptions
COPY
Request Body
SubscriptionSpec of type(s) application/json
Required 
{
    "blocking": false,
    "criteria": "string",
    "subscriberId": "string",
    "description": "string",
    "id": "string",
    "eventTopicId": "string",
    "requeueDelay": 0,
    "messageTTL": 0
}
boolean
blocking
Optional

blocking

string
criteria
Optional

criteria

string
subscriberId
Optional

subscriberId

string
description
Optional

description

string
id
Optional

id

string
eventTopicId
Optional

eventTopicId

integer As int64 As int64
requeueDelay
Optional

requeueDelay

integer As int64 As int64
messageTTL
Optional

messageTTL

Responses
201

'Created' with the newly registered Subscription

Returns Subscription of type(s) */* 
{
    "endpoint": "string",
    "endpoints": [
        {
            "protocol": "string",
            "endpoint": "string"
        }
    ],
    "blocking": false,
    "criteria": "string",
    "subscriberId": "string",
    "description": "string",
    "id": "string",
    "eventTopicId": "string",
    "requeueDelay": 0,
    "reply": false,
    "messageTTL": 0
}
string
endpoint
Optional

endpoint

array of SubscriptionEndpoint
endpoints
Optional

endpoints

boolean
blocking
Optional

blocking

string
criteria
Optional

criteria

string
subscriberId
Optional

subscriberId

string
description
Optional

description

string
id
Optional

id

string
eventTopicId
Optional

eventTopicId

integer As int64 As int64
requeueDelay
Optional

requeueDelay

boolean
reply
Optional

reply

integer As int64 As int64
messageTTL
Optional

messageTTL


On This Page
Subscription Operations
POST
Register Subscription