Write Message¶
Write message to data source through a specified channel.
Prerequisites¶
Write channels are created and started in the organization.
Request Format¶
POST https://{apigw-address}/data-federation/v2.0/channels/write/{channelId}/msg
Request Parameters (Header)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
Content-Type | Mandatory | String | Content or file type. The default value is application/json. |
Request Parameters (URI)¶
Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
orgId | Query | Mandatory | String | The organization ID. How to get the orgId>> |
channelId | Path | Mandatory | String | The channel ID. |
Request Parameters (Body)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
dataSourceName | Mandatory | String | The data source alias. |
data | Mandatory | String | The data to be written to the storage. |
sync | Mandatory | Boolean | Specify the data writing method.
|
Response Parameters¶
Name | Data Type | Description |
---|---|---|
failures | List<Object> | The list of data that failed to write to storage. For more information, see Failure Record Struct |
Failure Record Struct¶
Name | Data Type | Description |
---|---|---|
info | List<Object> | The failure record details. For more information, see Failure Record Details |
line | List<Object> | The failure data. |
Failure Record Details¶
Name | Data Type | Description |
---|---|---|
field | String | The data field that failed to write to storage. |
reason | String | The reason for failure. |
Samples¶
Request Sample¶
url: https://{apigw-address}/data-federation/v2.0/channels/write/{channelId}/msg?orgId={}
method: POST
requestBody:
{
"dataSourceName": "mysql_remote",
"data": "{\"table\":\"data\",\"lines\":[{\"WGEN.GenReactivePW\":\"2.5283\",\"ou_id\":\"o15622268182161\",\"WTUR.TurbineListSts\":\"5\",\"WTUR.TurbineUnionSts\":\"71\",\"WTUR.ConnectionSts\":\"0\",\"WGEN.GenActivePW\":\"45.700001\",\"WROT.TemB2Mot\":\"29.504801\",\"WTUR.TurbineTopSts\":\"2\",\"WGEN.TorqueSetpoint\":\"867.359375\",\"WWPP.PPCurrentDay\":\"0\",\"WCNV.GridFreq\":\"49.971561\",\"WWPP.PPCurrentYear\":\"17896\",\"dev_id\":\"04mmQAEM\",\"WNAC.TemOut\":\"25.691801\",\"WWPP.PPCurrentMonth\":\"33763\",\"WTUR.TurbineHealthSts\":\"0\",\"timeOfDay\":\"2019-09-01 00:00:00\",\"WTUR.TurbineGroupSts\":\"70\"},{\"WGEN.GenReactivePW\":\"2.7037\",\"ou_id\":\"o15622268182161\",\"WTUR.TurbineListSts\":\"5\",\"WTUR.TurbineUnionSts\":\"71\",\"WTUR.ConnectionSts\":\"0\",\"WGEN.GenActivePW\":\"45.439999\",\"WTUR.TurbineTopSts\":\"2\",\"WGEN.TorqueSetpoint\":\"865.127869\",\"WCNV.GridFreq\":\"49.998112\",\"dev_id\":\"04mmQAEM\",\"WTUR.TurbineHealthSts\":\"0\",\"timeOfDay\":\"2019-09-01 00:00:01\",\"WTUR.TurbineGroupSts\":\"70\"}]}"
"sync":true
}
Return Sample¶
{
"msg": "OK",
"code": 0,
"failures": [
{
"line": [],
"info": [
{
"reason": "",
"field": ""
}
]
}
],
"submsg": ""
}