(Early Access) Returns the requested Event API Product

Response body

object

data

object

required

id

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

name

string

required

length between 0 and 128

applicationDomainId

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

applicationDomainName

string

required

length between 0 and 128

brokerType

string

required

Defaults to solace

The type of the broker used for the event API product

kafka solace

customAttributes

array of objects

required

length between 0 and 256

Custom attributes defined in Event Portal

customAttributes*

object

name

string

required

length between 4 and 128

value

string

required

length between 0 and 10000

Valid Objects are Strings with characters

attributes

array of objects

required

length between 0 and 256

Attributes managed by integrations and external clients.

attributes*

object

name

string

required

length between 4 and 128

value

string

required

length between 0 and 10000

Valid Objects are Strings with characters

createdTime

int64

required

-1 to 9007199254740991

updatedTime

int64

required

-1 to 9007199254740991

createdBy

string

required

length between 4 and 64

changedBy

string

required

length between 4 and 64

description

string

length ≤ 10000

version

string

required

a version number in semver (Semantic Versioning) format

summary

string

length between 0 and 1024

displayName

string

length between 0 and 128

state

string

required

RELEASED DEPRECATED RETIRED DELETED

plans

array of objects

required

length between 1 and 128

plans*

object

id

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

name

string

required

length between 0 and 128

solaceClassOfServicePolicy

object

required

Solace class of service policy

apis

array of objects

required

length between 0 and 999

apis*

object

id

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

description

string

length between 0 and 10000

version

string

required

length between 2 and 64

displayName

string

length between 0 and 128

name

string

required

length between 0 and 128

customAttributes

array of objects

required

length between 0 and 256

customAttributes*

object

name

string

required

length between 4 and 128

value

string

required

length between 0 and 10000

Valid Objects are Strings with characters

solaceMessagingServices

array of objects

required

length between 1 and 128

Solace Messaging Services

solaceMessagingServices*

object

id

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

messagingServiceId

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

messagingServiceName

string

required

length between 0 and 128

supportedProtocols

array of strings

required

length between 1 and 32

Values for allowed supported protocols

supportedProtocols*

environmentName

string

required

length between 0 and 128

eventMeshName

string

required

length between 0 and 128

solaceCloudMessagingServiceId

string

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

apiParameters

array of objects

required

length between 0 and 32768

apiParameters*

object

name

string

required

length between 2 and 512

name of the parameter

dataType

string

required

data type of the parameter

string

parameterType

string

required

type of the parameter enum for enumerations, unbounded for free form values

enum unbounded

values

array of strings

length between 1 and 32768

any allowed values for the parameter. For the parameter type enum the values included are based on the filters in the Event API Product in Event Portal. For unbounded values may not be defined if there is no corresponding filter in the Event API Product. Otherwise the array may contain one or multiple items

values

approvalType

string

required

Defaults to automatic

Approval type

automatic manual

200the Event API Product

400Bad Request.

401Unauthorized.

403Forbidden.

404Not Found.

406Not Acceptable.

429Too many requests.

500Internal Server Error.

503Service Unavailable.

504Gateway Timeout.

defaultthe Event API Product