Difference between revisions of "NATS5 REST API Report GET focuses"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Report GET focuses to NATS5 REST API Report GET focuses: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /report/focuses''' == | == '''GET /report/focuses''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get available report focuses | * Get available report focuses | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 25: | Line 26: | ||
** required | ** required | ||
* '''enabled''' | * '''enabled''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional (default value: 1) | ** optional (default value: 1) | ||
| Line 84: | Line 85: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_report_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Revision as of 15:46, 9 August 2019
GET /report/focuses
Description
- Get available report focuses
Resource URL
- http://domain/api/report/focuses
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- report
- type: string
- required
- enabled
- type: boolean_digit (0 or 1)
- optional (default value: 1)
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = array(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/report/focuses',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
