Linkage Management

Create a linkage

• API intent: config.linkage.create
• Description: This interface is used to create linkage. You can customize the trigger conditions (Conditions) and execution actions (Actions). When the trigger conditions are met, the set actions are automatically executed. Through "query.ifttt.trigger" interface and "query.ifttt.action" interface query conditions and action parameter descriptions, then create a linkage through this interface.
• Request parameters

conditions description

condition description

Note: Timing time format: “min hour day month week”.

• “min”: The value ranges from 0 to 59. The value \ indicates that the minute is not limited.*
• “hour”: The value ranges from 0 to 23. The value \ indicates that the hour is not limited.*
• “day”: The value ranges from 1-31, and the value \ indicates no limit to the day, any day.*
• “month”: The value ranges from 1 to 12, and the value \ indicates no limit to the month, any month.*
• “week”: The value range is 0-8, 0 means Sunday, 1-6 means Monday-Saturday, 7 means holiday, 8 means working day, value \ indicates no limit to the week*.

For example:

• “10 11 * * 1,2,3,4,5,6,0” means 11:10 am every day
• “20 18 * * 1,4,6” means 18:20 pm every Monday, Thursday and Saturday

actions description

action content description

params description

• Request Demo (For more examples, please see demo)

{
  "intent": "config.linkage.create",
  "data": {
    "name": "123456",
    "positionId": "real1.768799734012641280",
    "conditions": {
      "condition": [
        {
          "triggerDefinitionId": "TD.lumi.gateway.illumination_less_than",
          "model": "lumi.gateway.acn01",
          "beginTime": "0 2 * * 1,2,3,4,5,6,0",
          "endTime": "0 4 * * 1,2,3,4,5,6,0",
          "params": [
            {
              "paramType": "0",
              "paramUnit": "Lux",
              "paramId": "PD.illumination",
              "value": "10"
            }
          ],
          "subjectId": "virtual2.11774113824794"
        }
      ],
      "relation": 0
    },
    "actions": {
      "action": [
        {
          "delayTimeUnit": "1",
          "actionDefinitionId": "AD.lumi.gateway.open_corridor_light",
          "model": "lumi.gateway.acn01",
          "delayTime": "480",
          "subjectId": "virtual2.11774113824794"
        }
      ]
    }
  }
}

• Response parameters

• Response demo

{
  "code": 0,
  "message": "Success",
  "msgDetails": "",
  "requestId": "",
  "result": {
    "linkageId": "L.836622570871640064"
  }
}

Update linkage

• API intent: config.linkage.update
• Description: This interface is used to modify the parameter configuration and name of linkage, and does not support modifying the location of linkage.
• Request parameters

conditions description

condition description

actions description

action description

params description

• Request Demo

{
  "intent": "config.linkage.update",
  "data": {
    "linkageId": "L.836622570871640064",
    "name": "123456",
    "positionId": "real1.768799734012641280",
    "conditions": {
      "condition": [
        {
          "subjectId": "virtual2.11774113824794",
          "triggerDefinitionId": "TD.lumi.gateway.light_off"
        }
      ],
      "relation": 0
    },
    "actions": {
      "action": [
        {
          "subjectId": "virtual2.11774113824794",
          "actionDefinitionId": "AD.lumi.gateway.open_corridor_light"
        }
      ]
    }
  }
}

• Response parameters: NA

• Response demo

{
  "code": 0,
  "message": "Success",
  "msgDetails": "",
  "requestId": "",
  "result": ""
}

Delete linkage

• API intent: config.linkage.delete
• Description: This interface is used to delete linkage.
• Request parameters

• Request Demo

{
  "intent": "config.linkage.delete",
  "data": {
    "linkageId": "L.836624600822501376"
  }
}

• Response parameters: NA

• Response demo

{
  "code": 0,
  "message": "Success",
  "msgDetails": "",
  "requestId": "",
  "result": ""
}

Enable/disable linkage

• API intent: config.linkage.enable
• Description: This interface is used to enable and disable linkage. When linkage is disabled, even if the trigger conditions are met, the linkage execution cannot be triggered automatically.
• Request parameters

• Request demo

{
  "intent": "config.linkage.enable",
  "data": {
    "linkageId": "L.836622570871640064",
    "enable": 0
  }
}

• Response parameters:NA

• Response demo

{
  "code": 0,
  "message": "Success",
  "msgDetails": "",
  "requestId": "",
  "result": ""
}

Query detail information of the linkage

• API intent: query.linkage.detail
• Description: This interface is used to query the configuration details of linkage conditions and actions.
• Request parameters

• Request Demo

{
  "intent": "query.linkage.detail",
  "data": {
    "linkageId": "L.835941240442339328"
  }
}

• Response parameters

Conditions description

Conditions content description

actions description

action content description

params description

• Request Demo

{
  "code": 0,
  "message": "Success",
  "msgDetails": "",
  "requestId": "",
  "result": {
    "linkageId": "L.835941240442339328",
    "enable": 1,
    "name": "test",
    "conditions": {
      "condition": [
        {
          "triggerDefinitionId": "TD.lumi.gateway.illumination_less_than",
          "triggerName": "Below assigned illuminance",
          "model": "lumi.gateway.acn01",
          "beginTime": "0 2 * * 1,2,3,4,5,6,0",
          "endTime": "0 4 * * 1,2,3,4,5,6,0",
          "params": [
            {
              "paramType": "0",
              "paramUnit": "Lux",
              "paramId": "PD.illumination",
              "value": "10"
            }
          ],
          "subjectId": "virtual2.11774113824794"
        }
      ],
      "relation": 0
    },
    "actions": {
      "action": [
        {
          "delayTimeUnit": "1",
          "actionDefinitionId": "AD.lumi.gateway.open_corridor_light",
          "model": "lumi.gateway.acn01",
          "delayTime": "480",
          "subjectId": "virtual2.11774113824794",
          "actionName": "Turn on night light"
        }
      ]
    }
  }
}

Query linkage list based on object ID

• API intent: query.linkage.listBySubjectId
• Description: This interface can query the associated linkage list based on the object ID.
• Request parameters

• Request Demo

{
    "intent": "query.linkage.listBySubjectId",
    "data": {
        "subjectId": "virtual2.11774113824794"
    }
}

• Response parameters

• Response demo

{
    "code": 0,
    "message": "Success",
    "msgDetails": "",
    "requestId": "",
    "result": [
        {
            "localize": 0,
            "linkageId": "L.826490791388536832",
            "enable": 1,
            "name": "1",
            "model": "app.ifttt.v1"
        },
        {
            "localize": 0,
            "linkageId": "L.826513247100755968",
            "enable": 0,
            "name": "test",
            "model": "app.ifttt.v1"
        }
    ]
}

Query linkage list based on location

• API intent: query.linkage.listByPositionId
• Description: This interface is used to query the linkage list under the specified location.
• Request parameters

• Request Demo

{
  "intent": "query.linkage.listByPositionId",
  "data": {
    "positionId": "real1.768799734012641280",
    "pageSize": 50,
    "pageNum": 1
  }
}

• Response parameters

data description

• Response demo

{
  "code": 0,
  "message": "Success",
  "msgDetails": "",
  "requestId": "",
  "result": {
    "data": [
      {
        "localizd": 0,
        "linkageId": "L.835941240442339328",
        "enable": 1,
        "name": "test",
        "positionId": "xxxxx",
        "model": "app.ifttt.v1"
      },
      {
        "localizd": 0,
        "linkageId": "L.826490791388536832",
        "enable": 1,
        "name": "1",
        "positionId": "xxxxx",
        "model": "app.ifttt.v1"
      }
    ],
    "totalCount": 6
  }
}