Required role: | SysAdmin |
GET | /sync/schemas |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Result | form | List<ErpCompanySyncInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyCode | form | string | No | |
CompanyName | form | string | No | |
SyncInfo | form | List<SyncInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
SourceDBConn | form | string | No | |
SourceDBType | form | string | No | |
SchemaName | form | string | No | |
Scopes | form | List<SyncScope> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Tables | form | List<SyncTable> | No | |
IsTemplate | form | bool | No | |
NameTemplate | form | string | No | |
Params | form | List<SyncParam> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TableID | form | int | No | |
Params | form | List<string> | No | |
FilterClause | form | string | No | |
FilterColumns | form | List<string> | No | |
ProxyTable | form | bool | No | |
MergeFromTable | form | TableSchemaInfo | No | |
DtoTypeName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
SchemaName | form | string | No | |
Columns | form | List<ColumnSchemaInfo> | No | |
Indexes | form | List<IndexSchemaInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsPK | form | bool | No | |
DBColName | form | string | No | |
ColType | form | Type | No | |
DBType | form | DbType | No | |
SqlDBType | form | SqlDbType | No | |
Size | form | int | No | |
AllowNull | form | bool | No | |
NeedSize | form | bool | No | |
AutoIncrement | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Columns | form | List<string> | No | |
IsUnique | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SQLName | form | string | No | |
Name | form | string | No | |
DbType | form | DbType | No | |
Size | form | int | No | |
Value | 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 /sync/schemas 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: [ { CompanyCode: String, CompanyName: String, SyncInfo: [ { Name: String, SourceDBConn: String, SourceDBType: String, SchemaName: String, Scopes: [ { Name: String, Tables: [ { TableID: 0, Params: [ String ], FilterClause: String, FilterColumns: [ String ], ProxyTable: False, MergeFromTable: { Name: String, SchemaName: String, Columns: [ { IsPK: False, DBColName: String, DBType: AnsiString, SqlDBType: BigInt, Size: 0, AllowNull: False, NeedSize: False, AutoIncrement: False } ], Indexes: [ { Name: String, Columns: [ String ], IsUnique: False } ] }, DtoTypeName: String, Name: String, SchemaName: String, Columns: [ { IsPK: False, DBColName: String, DBType: AnsiString, SqlDBType: BigInt, Size: 0, AllowNull: False, NeedSize: False, AutoIncrement: False } ], Indexes: [ { Name: String, Columns: [ String ], IsUnique: False } ] } ], IsTemplate: False, NameTemplate: String, Params: [ { SQLName: String, Name: String, DbType: AnsiString, Size: 0, Value: String } ] } ] } ] } ] }