Use the List Notification Status by Event UUID REST Service to list
the notification status of an event by using its event universal identifier (UUID).
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/ckms/notification/status/{eventUUID}
By default, Guardium® Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM® Security Guardium Key Lifecycle Manager installation, you can modify this
default port.
Request Parameters
Parameter |
Description |
host |
Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server. |
port |
Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests. |
Request body
JSON Object with the following specification.
JSON property name |
Description |
eventUUID |
Specify the universal unique identifier (UUID) of the event. Use the List Notification REST Service to obtain the UUID of the event. |
Request Headers
Header name |
Value |
Content-Type |
application/json |
Accept |
application/json |
Authorization |
SKLMAuth userAuthId=<authIdValue> |
Accept-Language |
Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or
de. |
Response Headers
Header name |
Value and description |
Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
Content-Type |
application/json |
Content-Language |
Locale for the response message. |
Success response body
JSON object with the following specification.
JSON property name |
Description |
code |
Returns the code that is specified by the status
property. |
status |
Returns a message that indicates the status of the operation. |
Error Response Body
JSON object with the following specification.
JSON property name |
Description |
code |
Returns the application error code. |
message |
Returns a message that describes the error. |
Examples
- Service request
-
GET https://localhost:port/SKLM/rest/v1/ckms/notification/status/NOT_EVENT-fed6658-f11fba8a-a9ca-4835-b4bd-9d0e0a9d4062
- Success response
-
[
{
"eventUUID": "NOT_EVENT-fed6658-f11fba8a-a9ca-4835-b4bd-9d0e0a9d4062",
"tenantId": "0",
"channelType": "email",
"delivered": "0",
"numberOfTries": "1"
}
]