New columns can be added to an existing Relational Table without manual user interface interaction.
Functionalities available
This REST API call has POST functionalities.
Method: POST
URI:/rest/relationaltables/{relationalTableId}/columns
Sample Request Body
{
“columnName”: “2019 Membership”,
“columnType”: “YesNo”,
“required”: false
}
Only columnName and columnType elements are required. The required element is optional.
Swagger URL
Rules for columnName
-
Special characters “/”, “.”, “&”, “<", "," and ">” are not allowed.
-
System reserved names (EMAIL) are not allowed.
Rules for columnType
The only accepted values are
Text
YesNo
Numeric
Date
Time
Timestamp
Email
PhoneNumber
Rules for required
Must be either true or false.
Response Codes:
Condition | Status Code/Error Level | Error Message |
---|---|---|
New column was added. | 200 | n/a |
Invalid value provided for {relationalTableId} or user does not have access to the Relational Table | 404 – generalErrors | Relational Table not found |
columnName was not provided | 400 – fieldErrors | columnName: Missing required data |
columnType was not provided | 400 – fieldErrors | columnType: Missing required data |
Invalid value for columnName was provided | 400 – fieldErrors | columnName: Invalid value |
Invalid value for columnType was provided | 400 – fieldErrors | columnType: Invalid value |
Invalid value for required was provided | 400 – fieldErrors | required: Invalid value |
Invalid element was supplied | 400 – fieldErrors | {element}: Invalid field or value |
Column already exists | 400 – generalErrors | A column with this name already exists |
Relational Table already has 400 columns | 400 – generalErrors | Maximum number of columns has been reached for this Relational Table |