Skip to main content
POST
Inject OCPP raw request to device

Authorizations

Authorization
string
header
required

OAuth2 Client Credentials Flow

Body

application/json

Request body containing the data need to send a request to the station

action
enum<string>
required

The name of the action to be executed

Available options:
CancelReservation,
ChangeAvailability,
ChangeConfiguration,
ClearCache,
ClearChargingProfile,
DataTransfer,
GetCompositeSchedule,
GetConfiguration,
GetDiagnostics,
GetLocalListVersion,
RemoteStartTransaction,
RemoteStopTransaction,
ReserveNow,
Reset,
SendLocalList,
SetChargingProfile,
TriggerMessage,
UnlockConnector,
UpdateFirmware,
CertificateSigned,
ClearDisplayMessage,
ClearVariableMonitoring,
CostUpdated,
CustomerInformation,
DeleteCertificate,
GetBaseReport,
GetChargingProfiles,
GetDisplayMessages,
GetInstalledCertificateIds,
GetLog,
GetMonitoringReport,
GetReport,
GetTransactionStatus,
GetVariables,
InstallCertificate,
PublishFirmware,
RequestStartTransaction,
RequestStopTransaction,
SetDisplayMessage,
SetMonitoringBase,
SetMonitoringLevel,
SetNetworkProfile,
SetVariableMonitoring,
SetVariables,
UnpublishFirmware
assetId
string
required

The id of the asset to send the request to

payload
object
required

The payload to be sent to the asset

network
object

The network to send the request to

async
boolean
default:true

Whether the request should be sent asynchronously. If false, the data will be present in the response

requestId
string

An optional request ID that will be used as the OCPP message ID. If not provided one will be generated.

injectActiveTransactionId
boolean
default:false

When true and the request is an OCPP 1.6 SetChargingProfile with a TxProfile purpose and no transactionId, the active transaction on the targeted connector is resolved and its id is set as csChargingProfiles.transactionId. For v2-native stations this happens in this API (responding 400 NO_ACTIVE_TRANSACTION when the connector has no ongoing transaction); for gateway-connected stations the ocpp processor injects the id as the command passes through it. Any other request passes through unchanged.

Response

OK

status
enum<string>
required

The status of the response

Available options:
Success
async
boolean
required

Whether the request was sent asynchronously, if it is false, the data will be present in the response otherwise data will be .

ocppMessageId
string
required

The id of the OCPP message

data
object

The data of the response