edittab (Edit a table)

The edittab transaction changes the table metadata (table information acquired via tabinfo).

Query string

The query string in the HTTP header must contain the following parameters:

api
Specify the name of the API transaction.
apiversion
Specify the version of the API that should handle the requested transaction.

For the most up-to-date version, use apiversion=3.

uid
Specify a valid 1010data user name.
pswd
Specify a valid password for the 1010data user name provided to the uid parameter.
Note: The pswd value should be the encrypted password returned from the login transaction.
sid
The session ID for the current API session.

This value is returned by the login transaction and must be provided to every transaction (except login).

kill (optional)
Valid values for kill are as follows:
yes
Terminate the existing session and start a new one.
no
Do not terminate the existing session.

If no session exists, a new one will be created. If a session does exist, an error is returned.

Note: If kill=no and a session is active, the system returns an error.
possess
Log in and possess the existing session.
auth
Authenticate with the system but do not kill, possess, or start any session.

The default is yes.

Query String Example

https://www2.1010data.com/gw.k?api=edittab&apiversion=3&uid=$UID&pswd=$PSWD&sid=$SID

XML Input to Server

The specifications consist of the table element from the XML response of tabinfo. The difference is that one can opt to only transmit the top level elements being updated. See tabinfo (Get information about a table) for detailed info about the response specification.

The following element is required: <table name="path.to.table">

The table element is required and must contain at least one of the following. See tabinfo XML output for a detailed schema.

XML Element To Send Description of Sent Element Content
<title> Table title
<secure> Secure SSL access
<owner> Table owner
<ldesc> Long description of the table
<link> Link header
<cols> Column information

XML Input Example

<in>
  <table name="mycompany.mytable">
    <title>Mytable’s new Title</title>
  </table>
</in>

XML Response from Server

A successful result contains the following elements:

XML Element Returned Description of Returned Element Content
<rc> Return code
<msg> Message

XML Response Example

<out>
  <rc>0</rc>
  <msg>edittab successful</msg>
</out>