access_via_api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| access_via_api [2019/03/12 14:45] – akuzmuk | access_via_api [2019/06/07 14:29] – akuzmuk | ||
|---|---|---|---|
| Line 624: | Line 624: | ||
| To obtain entries from the register register, you must perform follwing GET request on a URL http:// | To obtain entries from the register register, you must perform follwing GET request on a URL http:// | ||
| - | In the request headers, it is necessary to pass the API key, the boundaries of the time interval of interest, and a list of register identifiers. X-WH-START and X-WH-END are transmitted in UnixTime format. The register ID is passed by a comma-separated list in the X-WH-REG-IDS | + | In the request headers, it is necessary to pass the API key, the boundaries of the time interval of interest, and a list of register identifiers. X-WH-START and X-WH-END are transmitted in UnixTime format. The register ID is passed by a comma-separated list in the X-WH-REGISTERS |
| X-WH-APIKEY: | X-WH-APIKEY: | ||
| X-WH-START: 1422595501 | X-WH-START: 1422595501 | ||
| X-WH-END: 1422599101 | X-WH-END: 1422599101 | ||
| - | X-WH-REG-IDS: 8,10 | + | X-WH-REGISTERS: 8,10 |
| | | ||
| Also, in the headers, you must specify the desired data exchange format. Currently, only the JSONformat is supported. | Also, in the headers, you must specify the desired data exchange format. Currently, only the JSONformat is supported. | ||
| Line 648: | Line 648: | ||
| X-WH-START: 1422595501 | X-WH-START: 1422595501 | ||
| X-WH-END: 1422599101 | X-WH-END: 1422599101 | ||
| - | X-WH-REG-IDS: 8,10 | + | X-WH-REGISTERS: 8,10 |
| Reply example: | Reply example: | ||
| Line 883: | Line 883: | ||
| X-WH-APIKEY: | X-WH-APIKEY: | ||
| - | In the request headers, you must pass the connection IDs (IDs). Register values will be returned only from those connections whose ID are specified in the X-WH-CONNS header. ID should be separated by comma, without spaces. This allows you to request not all registers, but only a part. | + | In the request headers, you must pass the connection IDs (IDs). Register values will be returned only from those connections whose ID are specified in the X-WH-CONNECTIONS |
| Example: | Example: | ||
| - | X-WH-CONNS: 1,2 | + | X-WH-CONNECTIONS: 1,2 |
| | | ||
| In this example, register values for the ID=1 and ID=2 will be returned. | In this example, register values for the ID=1 and ID=2 will be returned. | ||
| Line 906: | Line 906: | ||
| Accept-Encoding: | Accept-Encoding: | ||
| X-WH-APIKEY: | X-WH-APIKEY: | ||
| - | X-WH-CONNS: 1,2 | + | X-WH-CONNECTIONS: 1,2 |
| | | ||
| Example of the response: | Example of the response: | ||
| Line 1300: | Line 1300: | ||
| To get data from graph log, it is necessary to run following GET-query for URL http:// | To get data from graph log, it is necessary to run following GET-query for URL http:// | ||
| - | Also, instead of specifying the graph ID, you can send the X-WH-REGS header. It specifies, through the comma, the ID of the registers for which data is to be extracted. Example: | + | Also, instead of specifying the graph ID, you can send the X-WH-REGISTERS |
| - | X-WH-REGS: 23,12,4 | + | X-WH-REGISTERS: 23,12,4 |
| In the request headers, you must pass the API key, the boundaries of the time interval of interest (X-WH-START, | In the request headers, you must pass the API key, the boundaries of the time interval of interest (X-WH-START, | ||
access_via_api.txt · Last modified: 2023/03/02 10:53 by emozolyak