On this page
Product events API
Generated Golden API operations for Product events.
Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.
6 operations.
GET /api/events/id/{id}
Retrieves a single event.
Operation ID: getSingleEvent
Locates an event by identifier and returns it. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string | Event identifier minLength: 1 |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful operation | application/json: EventResponseDto |
400 | Invalid parameters | application/json: BaseResponseDto |
401 | Authentication required | application/json: BaseResponseDto |
403 | Not authorized | application/json: BaseResponseDto |
404 | Resource not found | application/json: BaseResponseDto |
409 | Object is not in the correct state | application/json: BaseResponseDto |
DELETE /api/events/id/{id}
Deletes an event by identifier.
Operation ID: deleteEventByIdentifier
Locates an event by identifier and deletes it. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string | Event identifier to be deleted |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful operation | application/json: EventResponseDto |
400 | Invalid parameters | application/json: BaseResponseDto |
401 | Authentication required | application/json: BaseResponseDto |
403 | Not authorized | application/json: BaseResponseDto |
404 | Resource not found | application/json: BaseResponseDto |
409 | Object is not in the correct state | application/json: BaseResponseDto |
GET /api/events/sink/{id}
Retrieves a page of filtered events for a certain sink.
Operation ID: getEventPage
Locates events for indicated sink, filters and returns the page of events. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string | Sink identifier minLength: 1 |
filter | query | true | string | Event filter enum: [“ALL”, “VALID”, “INVALID”]; default: “ALL” |
pageNumber | query | true | integer (int32) | Page number default: 0; minimum: 0 |
pageSize | query | true | integer (int32) | Page size, at most 1000. A larger value is a 400, not a clamped page. default: 10; maximum: 1000; exclusiveMinimum: 0 |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful operation | application/json: EventPageResponseDto |
400 | Invalid parameters | application/json: BaseResponseDto |
401 | Authentication required | application/json: BaseResponseDto |
403 | Not authorized | application/json: BaseResponseDto |
404 | Resource not found | application/json: BaseResponseDto |
409 | Object is not in the correct state | application/json: BaseResponseDto |
DELETE /api/events/sink/{id}
Deletes all events for a certain sink.
Operation ID: deleteEventsBySink
Locates all event for a certain sink and deletes them all. 404 when the sink does not exist and holds no events. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string | Sink identifier to delete events for |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful operation | application/json: EventDeleteResponseDto |
400 | Invalid parameters | application/json: BaseResponseDto |
401 | Authentication required | application/json: BaseResponseDto |
403 | Not authorized | application/json: BaseResponseDto |
404 | Resource not found | application/json: BaseResponseDto |
409 | Object is not in the correct state | application/json: BaseResponseDto |
GET /api/events/stats
Retrieves global statistics for events.
Operation ID: getStats
Calculates statistics for available events organized by sink. Requires the ADMIN role.
Security: bearerAuth
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful operation | application/json: EventStatsResponseDto |
400 | Invalid parameters | application/json: BaseResponseDto |
401 | Authentication required | application/json: BaseResponseDto |
403 | Not authorized | application/json: BaseResponseDto |
404 | Resource not found | application/json: BaseResponseDto |
409 | Object is not in the correct state | application/json: BaseResponseDto |
PUT /api/events/valid/{id}
Sets an event as valid.
Operation ID: validEvent
Locates an existing event and sets validity to true. This only makes sense for events that are not valid. This event will be retried. Requires the ADMIN role.
Security: bearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | true | string | Event identifier to be set valid minLength: 1 |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful operation | application/json: EventResponseDto |
400 | Invalid parameters | application/json: BaseResponseDto |
401 | Authentication required | application/json: BaseResponseDto |
403 | Not authorized | application/json: BaseResponseDto |
404 | Resource not found | application/json: BaseResponseDto |
409 | Object is not in the correct state | application/json: BaseResponseDto |