API: HTTP Activate Field
The Relational Activate Field command allows you to allow data to be stored in a User Defined Relational Field.
Arguments
The Relational Activate Field command requires the following arguments: Command, Realm, Password, Table Name, Field Name.
api_web?r=myrealm&p=mypass&c=rdbactivatefields&table=mytable&fieldname=myfield
The command is 'rdbactivatefield', the realm is 'myrealm', the password is 'mypass', the table is 'mytable', and the field is 'myfield'. This command results in activation of the field.
The Relational Activate Field command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=rdbactivatefields c=rdbactivatefields |
|
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 in which the field exists. |
table=[table_name] |
|
Relational Field Name |
Yes |
Identifier of the relational data fields to activate. If activating multiple fields, include as a comma separated list, ie: |
fieldname=[field_name] |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?r=myrealm&p=mypass&c=rdbactivatefields&table=vehicles&fieldname=brand
Successful results return:
SUCCESS: Field brand activated for Relational Table vehicles
To activate multiple fields:
api_web?r=myrealm&p=mypass&c=rdbactivatefields&table=vehicles&fieldname=brand,make,model
Successful results return:
SUCCESS: Field brand activated for Relational Table vehicles
SUCCESS: Field make activated for Relational Table vehicles
SUCCESS: Field model activated for Relational Table vehicles
Results
The Activate Relational Field command outputs either a SUCCESS or FAILURE message.
SUCCESS
The Activate Relational Field command success message returns the SUCCESS message and includes the name of the table. The result format is:
SUCCESS: Field [fieldname] activated for Relational Table [tablename]
FAILURE
The Activate Relational Field command will fail for several reasons, for example if the field does not exist. The result format is:
FAILURE: Problem activating field [fieldname] for Custom Relational Table [tablename]