Method UserTableGetRecords

UserTableGetRecords(String, String, String, String, Boolean, List<WhereClauseElementContract>, List<OrderByClauseElementContract>)

Gets some rows from a user table

Declaration

List<List<string>> UserTableGetRecords(string connectionId, string userTable, string whereClause, string orderByClause, bool addColumnHeaders, List<WhereClauseElementContract> whereClauseElements, List<OrderByClauseElementContract> orderByClauseElements)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.String	userTable	Name of the user table
System.String	whereClause	Deprecated: Use instead whereClauseElements
System.String	orderByClause	Deprecated: Use instead orderByClauseElements
System.Boolean	addColumnHeaders	Adds column headers as first row
System.Collections.Generic.List<WhereClauseElementContract>	whereClauseElements	Optional: A list of SQL where clause elements. Can be null. See also WhereClauseElementContract
System.Collections.Generic.List<OrderByClauseElementContract>	orderByClauseElements	Optional: A list of SQL order by clause elements. Can be null. See also OrderByClauseElementContract

Returns

Type	Description
System.Collections.Generic.List<System.Collections.Generic.List<System.String>>	Some rows and columns from a user table

Examples

POST https://YourServerName/InfoShare/Json/UserTable/UserTableGetRecords

This example gets rows and the column headers from a user table filtered by a where clause.

{ 
 "connectionId": "4a0e7f66-b18f-48f0-8d5e-8999934b1da0",
 "userTable": "UserTable_Test1",
 "whereClauseElements": [
   { "ColumnName":"column1", "RelationalOperator":"Like", "Value":"row2%", "LogicalOperator":"OR" },
   { "ColumnName":"column1", "RelationalOperator":"Like", "Value":"row3%" }
  ],
 "orderByClauseElements": [ 
   { "ColumnName":"column1" }
  ],
 "addColumnHeaders": false
}

Response:

{ 
 "UserTableGetRecordsResult": [
  [ "row20_col1", "row20_col2", "", "row20_col4"],
  [ "row21_col1", "row21_col2", "", "row21_col4"],
  [ "row30_col1", "row30_col2", null, ""]
 ]
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Table name '{userTable}' is invalid. Allowed characters are: {allowedCharacters} (10184)
ServiceException	Parameter whereClauseElements[{whereClauseIndex}].RelationalOperator is invalid: Could not parse string '{relationalOperatorStr}' to a valid relational operator. Valid relational operators are: {allowedRelationalOperators} (10191)
ServiceException	Parameter whereClauseElements[{whereClauseIndex}].LogicalOperator is invalid: Could not parse string '{logicalOperatorStr}' to a valid logical operator. Valid logical operators are: {allowedLogicalOperators} (10192)
ServiceException	Parameter orderByClauseElements[{orderByClauseIndex}].SortOrder is invalid: Could not parse string '{sortOrder}' to a valid column sort order. Valid sort orders are: {allowedColumnSortOrders} (10193)
ServiceException	Parameter whereClauseElements[{i}].ColumnName is missing (10194)
ServiceException	Parameter whereClauseElements[{i}].RelationalOperator is missing (10195)
ServiceException	Parameter whereClauseElements[{i}].LogicalOperator is missing (10196)
ServiceException	Parameter whereClauseElements[{i}].Value cannot be null. Value can only be null, if whereClauseElements[{i}].RelationalOperator is {RelationalOperator.Equals} or {RelationalOperator.NotEquals} (10197)
ServiceException	Parameter whereClauseElements[{i}].LogicalOperator is superfluous because no condition follows (10198)
ServiceException	Parameter whereClauseElements[{whereClauseIndex}].EscapeCharacter is invalid: Could not parse string '{escapeCharacterStr}' to a valid escape character. Valid escape character is: {allowedEscapeCharacter} (10199)
ServiceException	Parameter whereClauseElements[{i}].EscapeCharacter is not allowed because the relational operator is neither {RelationalOperator.Like} nor {RelationalOperator.NotLike} (10200)
ServiceException	Table name '{userTable}' does not exist (10219)
ServiceException	Not enough rights ({accessOperationName}, {accessOperationId}) (10071)