ApexERPHost

<back to all web services

ExecuteDbServerAction

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
POST/dbadmin/servers/databases/action/{ActionId*}
POST/dbadmin/servers/{ServerId}/databases/action/{ActionId*}
ExecuteDbServerAction Parameters:
NameParameterData TypeRequiredDescription
ServerIdpathstringNo
DbNamebodystringNo
ActionIdpathstringNo
ParametersbodyDictionary<string, string>No
ExecuteDbServerActionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultSetformList<DynamicData>No
MetaformDictionary<string, string>No
DynamicData Parameters:
NameParameterData TypeRequiredDescription
SchemaformDynamicDataSchemaNo
DataformList<List<String>>No
DynamicDataSchema Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ColumnsformList<DataColumnInfo>No
DataColumnInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
TypeformintNo
MaxLengthformint?No
FormatformstringNo
ComplexTypeSchemaformDynamicDataSchemaNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /dbadmin/servers/databases/action/{ActionId*} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ServerId":"String","DbName":"String","ActionId":"String","Parameters":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ResultSet":[{"Schema":{"Name":"String","Columns":[{"Id":0,"Name":"String","Type":0,"MaxLength":0,"Format":"String","ComplexTypeSchema":{"Name":"String","Columns":[{"Id":0,"Name":"String","Type":0,"MaxLength":0,"Format":"String","ComplexTypeSchema":{"Name":"String","Columns":[{"Id":0,"Name":"String","Type":0,"MaxLength":0,"Format":"String"}]}}]}}]},"Data":[["String"]]}],"Meta":{"String":"String"}}