🎄 Happy Holidays! 🥳
Most of Solace is closed December 24–January 1 so our employees can spend time with their families. We will re-open Thursday, January 2, 2024. Please expect slower response times during this period and open a support ticket for anything needing immediate assistance.
Happy Holidays!
Please note: most of Solace is closed December 25–January 2, and will re-open Tuesday, January 3, 2023.
testing the Event Portal REST API
You can easily test the REST API of the Event Portal. Here is some examples I tested.
First, follow this section https://docs.solace.com/Solace-Cloud/Event-Portal/Event-Portal-REST-API.htm to get your access token (you'll need it to perform all of these requests).
How to retrieve events from an application domain?
First you need to get your domain ID: run
GET
on https://solace.cloud/api/v1/eventPortal/applicationDomains?name={nameOfYourDomain}
you will get a JSON as the reply and you'll be able to use the value of theid
elementthen you can run
GET
on https://solace.cloud/api/v1/eventPortal/events?applicationDomainId={theIdYouHaveRetrieved} and you'll get the list of all the events from this domain
How to create events?
Here is an example of a payload to create an event (this payload has to be sent with POST
verb on https://solace.cloud/api/v1/eventPortal/events)
{
"applicationDomainId": "{theIdYouHaveRetrieved}",
"description": "Customer Account",
"name": "customerAccount",
"revisionComment": "customerAccount",
"schemaId": null,
"shared": false,
"topicName": "myDomain/customerAccount/account/v1/{accountId}",
"type": "event",
"version": "1.0"
}
All these requests can be tested using Postman for instance (this is what I used).
Comments
-
That's great, thanks for sharing @Magali_Boulet! I haven't had a chance to play with the event portal REST API yet myself
Because the API is defined via OpenAPI you can also use this page to try out other parts of the API as well: http://openapi.solace.cloud/1