Search

Search…

Note: Ardexa hosts clouds in multiple regions as subdomains of ardexa.com.  Where you see a reference to mycloud in this document, replace it with the appropriate subdomain for your cloud, eg: mycloud.ardexa.com -> app.ardexa.com or eur1.ardexa.com
How to generate a list of Device names and IDs
The following command (uses curl and jq) can be used on any workgroup that you have access to to get a list of device names and their IDs 
curl -s -H "Authorization: Bearer $TOKEN" https://[mycloud].ardexa.com/api/v1/devices/${WORKGROUPID} | jq -r '.[] | "\(.name): \(.id)"'
 Where:

TOKEN = your API or User token
WORKGROUPID = is the ID of the target Workgroup (Admin -> Workgroup)
Building Searches
The following provide examples on how you can go about constructing messages against one of the Ardexa APIs
Search Scenarios, Operators and Examples
`=` (equals)
Example
​
      {                                                                                                       
        "field": "action", 
        "operator": "=", 
        "value": "send" 
      }
​
​
IN
Example
     
      {                                                                                                       
        "field": "action", 
        "operator": "IN", 
        "value": ["send","get","rename"]
      }
​

Devices

API Search Functions

Last modified 1yr ago

Copy link

Outline

How to generate a list of Device names and IDs

Building Searches

Search Scenarios, Operators and Examples