Retreive failed IEBUS messages
Version 1.0
Endpoint
GET
https://pinv.dev.att.com/failed-messages
Copy
This endpoint allows you to track messages from IEBUS that have failed or have only been partially succesfull. If multiple range filters are used (ending in **.lt, .lte, .gt, .gte**), the endpoint will return the intersection of all the used range filters. This endpoint is subject to authorization with the corresponding source.
http
scheme:bearer
bearerFormat:JWT
Query Parameters
- idCheck for failed messages by product IDExample: c31f5942-e198-4272-9811-ce4677d97b77
- id[]Subsequent product ID/s to check for failed messages, any number of query params can be added to the request, both "id=" and "id[]=" will work.Example: c31f5942-e198-4272-9811-ce4677d97b78
- offset-idCheck for failed messages by offset ID of sent IEBUS messageExample: 1337
- offset-id[]Subsequent offset ID/s to check for failed messages, any number of query params can be added to the request, both "offset-id=" and "offset-id[]=" will work.Example: 1338
- offset-id.ltFilter failed messages where the offset ID is **less than** (use **.lte** suffix for less than or equal to) the specified value. Only integer values >= 0 are valid.Example: 100
- offset-id.gtFilter failed messages where the offset ID is **greater than** (use **.gte** suffix for greater than or equal to) the specified value. Only integer values >= 0 are valid.Example: 50
- production-timestamp.ltFilter failed messages where the production timestamp is **less than** (use **.lte** suffix for less than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-29T09:26:29.602Z`) for ajv validation.Example: 2025-04-29T09:26:29.602Z
- production-timestamp.gtFilter failed messages where the production timestamp is **greater than** (use **.gte** suffix for greater than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-29T09:26:29.602Z`) for ajv validation.Example: 2025-04-28T09:26:29.602Z
- consumption-timestamp.ltFilter failed messages where the consumption timestamp is **less than** (use **.lte** suffix for less than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-29T09:26:29.602Z`) for ajv validation.Example: 2025-04-29T09:26:29.602Z
- consumption-timestamp.gtFilter failed messages where the consumption timestamp is **greater than** (use **.gte** suffix for greater than or equal to) the specified value. Timestamps must follow ISO 8601 format with `T` and `Z` (e.g., `2025-04-28T09:26:29.602Z`) for ajv validation.Example: 2025-04-28T09:26:29.602Z
- limitNumber of failed messages in one page (Default: 1000)Example: 1000
- offsetOffset position (Default: 0)Example: 0
Body Parameters
Responses
Failed message(s) successfully retrieved
Body
application/json
- Required