Difference between revisions of "NATS5 REST API Maintenance GET table"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /maintenance/table''' == '''Description''' * Get details on a table '''Resource URL''' *<nowiki>http://domain/api...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_maintenance_section = true |
}} | }} | ||
== '''GET /maintenance/table''' == | == '''GET /maintenance/table''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get details on a table | * Get details on a table | ||
| 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 | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''GET'''<br/> |
| + | URL: <nowiki>http://domain/api/maintenance/table</nowiki><br/> | ||
| + | Query String: <nowiki>table=transaction_summary</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "table": { | ||
| + | "Name": "transaction_summary", | ||
| + | "Engine": "InnoDB", | ||
| + | "Version": "10", | ||
| + | "Row_format": "Compact", | ||
| + | "Rows": "0", | ||
| + | "Avg_row_length": "0", | ||
| + | "Data_length": "16384", | ||
| + | "Max_data_length": "0", | ||
| + | "Index_length": "163840", | ||
| + | "Data_free": "0", | ||
| + | "Auto_increment": "1", | ||
| + | "Create_time": "2019-08-09 16:28:51", | ||
| + | "Update_time": null, | ||
| + | "Check_time": null, | ||
| + | "Collation": "latin1_swedish_ci", | ||
| + | "Checksum": null, | ||
| + | "Create_options": "", | ||
| + | "Comment": "", | ||
| + | "large": 1, | ||
| + | "type": "report", | ||
| + | "report_type": "summary", | ||
| + | "partitioned": 0, | ||
| + | "Data_length_nice": "16 Kb", | ||
| + | "Max_data_length_nice": "0 bytes", | ||
| + | "Index_length_nice": "160 Kb", | ||
| + | "clean": 0, | ||
| + | "currently_cleaning": 0, | ||
| + | "crashed": 0, | ||
| + | "report_details": { | ||
| + | "name": "Transaction Summary", | ||
| + | "type": "summary", | ||
| + | "table": "transaction_summary", | ||
| + | "rows": "0", | ||
| + | "processing": 0, | ||
| + | "max_date": 0, | ||
| + | "max_date_nice": "None", | ||
| + | "min_date": 0, | ||
| + | "min_date_nice": "None", | ||
| + | "currently_processing": 0 | ||
| + | }, | ||
| + | "summary_details": { | ||
| + | "name": "Transaction Summary", | ||
| + | "type": "summary", | ||
| + | "rows": "0", | ||
| + | "max_date": null, | ||
| + | "min_date": null, | ||
| + | "max_data_nice": "None", | ||
| + | "min_date_nice": "None", | ||
| + | "first_trans_date": null, | ||
| + | "last_trans_date": null, | ||
| + | "has_trans_data": 0, | ||
| + | "first_trans_date_nice": "None", | ||
| + | "last_trans_date_nice": "None", | ||
| + | "currently_processing": 0 | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?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( | ||
| + | 'table' => 'transaction_summary', | ||
| + | ); | ||
| + | |||
| + | $request = Array( | ||
| + | 'method' => 'GET', | ||
| + | 'path' => 'v1/maintenance/table', | ||
| + | '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); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS5_REST_APIs]] | ||
| + | [[Category:NATS5_REST_maintenance_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:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:59, 9 August 2019
GET /maintenance/table
Description
- Get details on a table
Resource URL
- http://domain/api/maintenance/table
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- table
- type: string
- required
Example Request
Method: GET
URL: http://domain/api/maintenance/table
Query String: table=transaction_summary
Response:
{
"success": true,
"table": {
"Name": "transaction_summary",
"Engine": "InnoDB",
"Version": "10",
"Row_format": "Compact",
"Rows": "0",
"Avg_row_length": "0",
"Data_length": "16384",
"Max_data_length": "0",
"Index_length": "163840",
"Data_free": "0",
"Auto_increment": "1",
"Create_time": "2019-08-09 16:28:51",
"Update_time": null,
"Check_time": null,
"Collation": "latin1_swedish_ci",
"Checksum": null,
"Create_options": "",
"Comment": "",
"large": 1,
"type": "report",
"report_type": "summary",
"partitioned": 0,
"Data_length_nice": "16 Kb",
"Max_data_length_nice": "0 bytes",
"Index_length_nice": "160 Kb",
"clean": 0,
"currently_cleaning": 0,
"crashed": 0,
"report_details": {
"name": "Transaction Summary",
"type": "summary",
"table": "transaction_summary",
"rows": "0",
"processing": 0,
"max_date": 0,
"max_date_nice": "None",
"min_date": 0,
"min_date_nice": "None",
"currently_processing": 0
},
"summary_details": {
"name": "Transaction Summary",
"type": "summary",
"rows": "0",
"max_date": null,
"min_date": null,
"max_data_nice": "None",
"min_date_nice": "None",
"first_trans_date": null,
"last_trans_date": null,
"has_trans_data": 0,
"first_trans_date_nice": "None",
"last_trans_date_nice": "None",
"currently_processing": 0
}
}
}
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(
'table' => 'transaction_summary',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/maintenance/table',
'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);
?>
