Getting the Entity Status

Producer users can call the /event/{entity_name}/status endpoint using GET to understand if the registry service instance has processed a specified entity. If processing of an entity was not successful, the producer can then take appropriate steps.

Currently, only entities of type USER are supported.

Item

Description

URI

/registry/api/v1/event/{entity_name}/status 

Method

GET 

Query parameters

entity_name (path parameter, required). Specify the user ID of the user whose status is queried.

entity_type (query parameter, required). Specify USER.

Request body

N/A

Response codes

200: Success

400: Bad request

401: Unauthorized

500: Internal server error

Sample Response

The response indicates the processing status, which can be one of the following values:

Processed—The entity has been processed successfully.
In-Progress—Processing of the entity is ongoing.
Cancelled—Processing of the entity did not complete due to an error.

Sample Response for Successful GET Call

The following shows a sample response for a successful GET call, which returns the status Processed for the specified user:

{

"status": "Processed"

}

Sample Responses for Failed GET Call

The following shows a sample response for a failed GET call that is returned when an invalid entity type is requested (status code 400, Bad Request).

{

"message": "Invalid Entity_Type. Supported types: [USER]"

}

The sample below shows the response for a failed GET call that is returned when a non-existing record is requested (status code 404, Not Found).

{

"message": "No record found!"

}