TableAPIShell

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

All requests need to have the:

- Authorization header in format : Authorization: TOKEN

- x-User header in format: x-User: USERNAME

- http://localhost:8839/core/json/ListRecords

• List all records in the table
• GET

- http://localhost:8839/core/json/DeleteRecord?key=id&value=14

• Key = the column used for the key field
• Value = the value of the key column to search for
• Deletes the record
• GET

- http://localhost:8839/core/json/UpdateRecordByKey?Key=id&KeyValue=g2

• Update record by key field en key value
• POST
• Body with JSON with the fields to update

- http://localhost:8839/core/json/EmptyTable

• Empties the table if the empty table option is set to true in the config
• GET

- http://localhost:8839/core/json/InsertRecord

• POST
• Inserts a record with the json in the body of the message

- http://localhost:8839/core/json/GetRecordByKey?key=id&value=g2

• The key and value are used to find the record
• GET

Configuration

Option	Description	Sample
DBServer	Database server name	TableAPIShell.Test.01
DB	Database name	TableAPIShell
Table	Table name of the table to monitor	APIData
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.