...
No Format |
---|
------ Sync : Get the current state of a cmhandle when cmhandle is READY ----------------
Request (sync)
GET {ncmp-root}/ncmp/v1/ch/<cmhandle>/state
Accept: application/json
Response
"state" : {
"cmHandleState" : "READY",
"dataSyncEnabled" : true,
"dataStoreSyncState" : { *
operationalStoreState {
"state" : "SYNCHRONIZED",
"lastSyncTime" : "2022-04-01 07:37:20"
}
}
}
* runningStoreState not included in response as it does not exist / is not supported (yet)
------ Sync :Get the current state of a cmhandle when cmhandle is LOCKED ---------------
Request (sync)
GET {ncmp-root}/ncmp/v1/ch/<cmhandle>/state
Accept: application/json
Response
"state" : {
"cmHandleState" : "LOCKED",
"lockReason" : {
"reason" : "LOCKED_MISBEHAVING",
"details" : "Error recovering Modules for cmhandle"
}
}
------ Async : Get the current state of a cmhandle when cmhandle is READY ----------------
Request (async)
GET {ncmp-root}/ncmp/v1/ch/<cmhandle>/state?topic=<topic-name>
Accept: application/json
Response
{
"requestId" : "dffrtg56-rt56"
}
Event :
"requestId" : "dffrtg56-rt56",
"data" : {
"cmhandle" : "dfsdgfw454df",
"state" : {
"cmHandleState" : "READY",
"dataSyncEnabled" : true,
"dataStoreSyncState" : {
operationalStoreState {
"state" : "SYNCHRONIZED",
"lastSyncTime" : "2022-04-01 07:37:20"
}
}
}
}
|
...