API: HTTP Activate Table
The Relational Activate Table command allows you to allow data to be stored in a User Defined Relational Table.
Arguments
The Relational Activate Table command requires the following arguments: Command, Realm, Password, Table Name.
api_web?r=myrealm&p=mypass&c=rdbactivatetable&table=mytable
The command is 'rdbactivatetable', the realm is 'myrealm' and the password is 'mypass' and the table is 'mytable'. This command results in activation of the table. A unique ID field must be defined in the table before it can be activated and used.
The Relational Activate Table command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=rdbactivatetable c=rdbactivatetable |
|
Realm |
Yes |
Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match. |
realm=[realm_name] r=[realm_name] |
|
Password |
Yes |
Authentication code for API access. This is required, and the command will fail if the realm and password do not match. |
pwd=[password] p=[password] |
|
Relational Table Name |
Yes |
Identifier of the relational data table to activate. |
table=[table_name] |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?r=myrealm&p=mypass&c=rdbactivatetable&table=vehicles
Successful results return:
SUCCESS: Relational Table vehicles has been activated
Results
The Activate Relational Table command outputs either a SUCCESS or FAILURE message.
SUCCESS
The Activate Relational Table command success message returns the SUCCESS message and includes the name of the table. The result format is:
SUCCESS: Relational Table [tablename] has been activated
FAILURE
The Activate Relational Table command will fail for several reasons, for example if the table does not have a Unique ID field. The result format is:
FAILURE: [Reason]
FAILURE: There is no Unique Field for the table [tablename]