REST Endpoint Examples

1. Retrieve column values from a table

GET url - http://127.0.0.1:8992?cmd=ats_retrieve_row - Suits performance testing use cases
body JSON- {
    "TableName”: "table_name",
    "ColumnNames”: ["column_name1","column_name2"]
}

This API call will give different column values for each request ,that means once a value is retrieved, it had been marked as retrieved and cannot be retrieved again

Open

2. Set values of multiple columns in a table

POST url - http://127.0.0.1:8992?cmd=ats_send_row
body JSON - {
    "TableName”: "table_name",
    "ColumnNames”: ["column_name1","column_name2"],
    "ColumnValues”: ["column_value1","column_value2"],
    "Type”: "ROW"                                                                
}

  Type have three values ROW, STACKED and UNIQUE

Open

3. Retrieve a column value from a table - Suits performance testing use cases , but can be used for other use cases with the help of RowIndex

GET url - http://127.0.0.1:8992?cmd=ats_retrieve_column
body JSON- {
    "TableName”: "table_name",
    "ColumnName”: "column_name"
}

By default this API call will give different column values for each request ,that means once a value is retrieved, it had been marked as retrieved and cannot be retrieved again. But in some cases if you want to retrieve always the same value , you need to pass the third parameter RowIndex

Open

4. Set a column value in a table

POST url - http://127.0.0.1:8992?cmd=ats_send_column
body JSON- {
    "TableName”: "table_name",
    "ColumnName”: "column_name",
    "ColumnValue”: "column_value",
    "Unique”: true
}

Open

5. Update a column value by row index in a table

POST url - http://127.0.0.1:8992?cmd=ats_update_column
    body JSON - {
    "TableName”: "table_name",
    "ColumnName”: "column_name",
    "ColumnValue”: "column_value”,
  “Unique”: false,
    " RowIndex “: 1
}

Open

6. Get the size of a table or column in a table

     POST url - http://127.0.0.1:8992?cmd=ats_retrieve_table_size
    body JSON - {
    "TableName”: "table_name",
    "ColumnName”: "column_name"                                ColumnName is optional
    }        

7. Retrieval of rows based on multiple column names and values. This API also supports an optional input OuputColumnNames, the column names in rows to be retrieved based on the matching column names and values

GET url - http://127.0.0.1:8992?cmd=ats_retrieve_row_by_column
body JSON- {
"TableName”: "table_name",
"MatchColumnNames": ["column_name1",”column_name2”],
"MatchColumnValues" : ["column_value1","column_value2"]
}

Open

8. Save a table after you have called any of the above APIs

POST url - http://127.0.0.1:8992?cmd=ats_save_table
    body JSON - {
    "TableName”: "table_name"
    }    

9. Retrieve all the records in a particular table

GET url - http://127.0.0.1:8992?cmd=ats_retrieve_all_rows
    body JSON - {
    "TableName”: "table_name"
    }