Get OCPI Message Logs
x-ms-visibility: "important"
Retrieves all OCPI message logs.
Query Parameters
page int32
Page to be fetched. Default: 1
limit int32
Limit (No. of records per page). Max value: 100. Default: 100.
from date-time
Start timestamp for the period to be fetched. Default: 7 days ago.
to date-time
End timestamp for the period to be fetched. Default: Now.
requestIds string[]
Filter by specific request IDs. Comma-separated list of request IDs.
correlationIds string[]
Filter by specific correlation IDs. Comma-separated list of correlation IDs.
logTypes string[]
Filter by specific log types. Comma-separated list of log types.
search string
Free text filter for request ID, correlation ID, log type, line content and message body.
sortKey string
Field to be used for sorting. Default: timeStamp
sortDescending boolean
Set to 'true' to sort descending based on sort key. Default: 'false'
Responses
- 200
- 400
- 401
OCPI message logs successfully retrieved.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
id int64
timestamp date-time
integrationId string
requestId string
correlationId string
logType string
line string
body string
approvedParty object
id int64
integrationType string
partyName string
partyId string
countryCode string
version string
versionUrl string
isPlatform boolean nullable
isSessionPutAlways boolean nullable
{
"page": 0,
"limit": 0,
"totalRecords": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"items": [
{
"id": 0,
"timestamp": "2025-06-25T07:58:51.658Z",
"integrationId": "string",
"requestId": "string",
"correlationId": "string",
"logType": "string",
"line": "string",
"body": "string",
"approvedParty": {
"id": 0,
"integrationType": "string",
"partyName": "string",
"partyId": "string",
"countryCode": "string",
"version": "string",
"versionUrl": "string",
"isPlatform": true,
"isSessionPutAlways": true
}
}
]
}
Validation error occurred.
application/json
Schema
Example (from schema)
Schema
errorCode string
message string
errorNumber int32
helpLink string
{
"errorCode": "string",
"message": "string",
"errorNumber": 0,
"helpLink": "string"
}
User not authorized.
Loading...