Search Results for

    Show / Hide Table of Contents

    Method UserTableGetTableInfo

    UserTableGetTableInfo(String, String)

    Gets user table information

    Declaration
    UserTableInfoContract UserTableGetTableInfo(string connectionId, string userTable)
    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

    Returns
    Type Description
    UserTableInfoContract

    Returns the user table information

    Examples

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

    This example shows how to get user table information.

    {
     "connectionId": "1bafdbc6-ac0f-4a2d-bade-a5ed1fb6177a",
     "userTable": "UserTable_AutoTest1"
    }

    Response:

    {
     "UserTableGetTableInfoResult": {
      "AutoIncrementColumn":"Id",
      "Columns": [ 
        { "AutoIncrement":true, "CharacterLength":null, "DataLength":null, "DataType":"bigint", "IsNullable":false, "Name":"Id", "NumericPrecision":19, "NumericScale":0, "OrdinalPosition":1 },  
        { "AutoIncrement":false, "CharacterLength":"max", "DataLength":null, "DataType":"nvarchar", "IsNullable":true, "Name":"column1", "NumericPrecision":null, "NumericScale":null, "OrdinalPosition":2 },
        { "AutoIncrement":false, "CharacterLength":"max", "DataLength":null, "DataType":"nvarchar", "IsNullable":true, "Name":"column2", "NumericPrecision":null, "NumericScale":null, "OrdinalPosition":3 },
        { "AutoIncrement":false, "CharacterLength":"max", "DataLength":null, "DataType":"nvarchar", "IsNullable":true, "Name":"column3", "NumericPrecision":null, "NumericScale":null, "OrdinalPosition":4 },
        { "AutoIncrement":false, "CharacterLength":"max", "DataLength":null, "DataType":"nvarchar", "IsNullable":true, "Name":"column4", "NumericPrecision":null, "NumericScale":null, "OrdinalPosition":5 }
       ],
      "TableName":"AutoTest2",
      "ProtectionDomainId": "1bafdbc6-ac0f-4a2d-bade-a5ed1fb6188b",
      "UserTableAccesRightsEnumList": [ { "Create", "Delete", "Read", "Edit", "ChangeDefinition", } ]
     }
    }
    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

    Table name '{userTable}' does not exist (10216)

    ServiceException

    Not enough rights ({accessOperationName}, {accessOperationId}) (10071)

    Back to top Copyright © Kendox