Required role: | SysAdmin |
GET | /dbadmin/servers/databases/tableinfo/columns | ||
---|---|---|---|
GET | /dbadmin/servers/{ServerId}/databases/tableinfo/columns |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServerId | path | string | No | |
DbName | query | string | No | |
Schema | query | string | No | |
Name | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Result | form | List<DbServerColumnInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
Type | form | string | No | |
MaxLength | form | int? | No | |
IsNullable | form | bool? | No | |
IsIdentity | form | bool? | No | |
DefaultConstraintsName | form | string | No | |
DefaultConstraintsValue | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /dbadmin/servers/databases/tableinfo/columns HTTP/1.1 Host: apex.nikoratrade.ge Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } }, Result: [ { Id: String, Name: String, Description: String, Type: String, MaxLength: 0, IsNullable: False, IsIdentity: False, DefaultConstraintsName: String, DefaultConstraintsValue: String } ] }