ApexERPHost

<back to all web services

SetDbServerObjectDescription

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
POST/dbadmin/servers/databases/objects/description
POST/dbadmin/servers/{ServerId}/databases/objects/description
SetDbServerObjectDescription Parameters:
NameParameterData TypeRequiredDescription
ServerIdpathstringNo
DbNamebodystringNo
ObjectTypebodyintNo
SchemabodystringNo
ParentbodystringNo
NamebodystringNo
DescriptionbodystringNo
SetDbServerObjectDescriptionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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/objects/description HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ServerId":"String","DbName":"String","ObjectType":0,"Schema":"String","Parent":"String","Name":"String","Description":"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"}}}