Index
Introduction
Disclaimer
Usage
Configuration
Logging
Introduction
This document describes the TableAPIShell Mini Connector. Please read this whole document to have a good understanding of how this tool works.
Disclaimer
The use of this tool is at users own risk. The user understands that Scope4mation is not responsible nor liable for any damages, unexpected results, costs or any other effect that might occur as a result of using this tool.
Usage
URL
BaseURL(config)/api function name/table name
Security
The Authorization header must contain the token configured in the config file
Api’s
EmptyTable (only works when EmptyTable options is set to true in the configuration file)
Will return 400 when the delete failed with a json containing the errors
Will return 200 with an OK message when the action is completed
DeleteRecord
Query variables :
Will return 400 when the delete failed with a json containing the errors
Will return 200 with an OK message when the action is completed
ListRecords
Will return 400 when the delete failed with a json containing the errors
Will return 200 with a json containing the records when the action is completed
Will return 204 when no content is found
To use filters add this example to your body and modify where needed:
"filters":
[
{
"field":"exampledate",
"op":">=",
"value":"12312312"
},
{
"field":" exampledate",
"op":"<=",
"value":"a123432423"
}
]
InsertRecord
Will return 400 when the insert failed with a json containing the errors
Will return 200 with an OK message when the action is completed
UpdateRecordByKey
Query variables :
Will return 400 when the delete failed with a json containing the errors
Will return 200 with an OK message when the action is completed
GetRecordByKey
Query variables :
Will return 400 when the delete failed with a json containing the errors
Will return 200 with the json object when the action is completed
Body
Body example:
{
"data":
{
"id":"4",
"test":"jan",
"intnog":512
},
"filters":
[
{
"field":"exampledate",
"op":">=",
"value":"12312312"
},
{
"field":"exampledate",
"op":"<=",
"value":"a123432423"
}
]
}
Configuration
| Option | Description | Sample |
| DBServer |
Database server name |
TableAPIShell.Test.01 |
| DB |
Database name |
TableAPIShell |
| Base URL | Base url to host on | http://localhost:8839 |
| DBUsername |
Username |
sa |
| DBPassword |
Password |
***** |
| EmptyTable |
True or false if the empty tabel request is allowed |
True |
| Token |
The token to validate if the request is valid. |
Valid |
| LogRetentionDays |
How many days the log file should be kept this is checked every 12 hours |
2 |
| UseLogServer |
True or False; When True, it will use the logging server. More info can be found here. |
False |
Logging (Optional)
The most common error message is the following:
1. No valid License found: The License should be located in the directory where the .exe of the MC is located.
If this did not fix the problem: Contact support.
You can read more about the logging settings here.