...
Supported NCMP API Requests (CPS-E-05):
No Format |
---|
------ Sync : Get the current state of a cmhandle when cmhandle is READY ------ Sync ------------------------------------------------------------------------------ Request (sync) GET {ncmp-root}/ncmp/v1/ch/<cmhandle>/state Accept: application/json Response "state" : { "cmHandleState" : "READY", "dataSyncEnabled" : true, "dataSyncStatedataStoreSyncState" : { * operationalStoreState { "state" : "SYNCHRONIZED", "lastSyncTime" : "2022-04-01 07:37:20" } } } * runningStoreState not included as it does not exist / is not supported (yet) ------ Sync :Get the current state of a cmhandle when cmhandle is LOCKED ------ Sync ------------------------------------------------------------------------------ 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, "dataSyncStatedataStoreSyncState" : { operationalStoreState { "state" : "SYNCHRONIZED", "lastSyncTime" : "2022-04-01 07:37:20" } } } } |