...
| Parameter Name | Description |
|---|---|
| type | The type of the request, either "resource" for a single record, or "collection" for list of records |
| address | The URI template. "/Customers/{CustNum}" means that the resources can be accessed using the resulting URI like http://localhost:8820/web/Entities/Customers/1 - The {CustNum} placeholder represents a field used in the resulting QueryString (FOR EACH eCustomer WHERE eCustomer.CustNum = 1). There can be multiple placeholders in a single URI template (e.g. /Customers/{CustNum}/Orders/{OrderNum}/OrderLines/{OrderLine} Collection or singleton (a single record resource that does not require any further selection criteria) may not require any value placeholder at all. |
| tables | The comma delimited list of tabels requested from the Business Entity (FetchDataRequest:Tables property) to serve the request |
| id | The comma delimited list of fields used to return the ID of a resource |
| fields | The comma delimited list of fields returned to the caller (by default), possible values may be field names, tablename.fieldname's or tablename.* |
| canRead | true/false, logical value determing of the URI supports read (GET) requests |
| canUpdate | true/false, logical value determing of the URI supports update requests (PUT and PATCH) - supported for individual records only |
| canCreate | true/false, logical value determing of the URI supports create requests (POST) - supported for collections only |
| canDelete | true/false, logical value determing of the URI supports delete (DELETE) requests - supported for collections and individual records |
| childAddresses | links to resource URI's for the child records returned by the request, comma delimited list, entries are in the form of {tablename}:{uri pattern}, e.g. eSalesrep:/Salesreps/~{SalesRep} |
| links | HATEOAS style links (to other business entities) in the form of {rel}:{uri pattern}, e.g.orders:/Customers/~{CustNum}/Orders,salesrep:/Salesreps/~{SalesRep} |
| tags | Comma-separated list of tags used for grouping endpoints in Swagger documentation. |
| methodDescrptionGet | (optional) A description for Swagger documentation for GET operations for this address. |
| methodDescrptionPut | (optional) A description for Swagger documentation for PUT operations for this address. |
| methodDescrptionPost | (optional) A description for Swagger documentation for POST operations for this address. |
| methodDescrptionPatch | (optional) A description for Swagger documentation for PATCH operations for this address. |
| methodDescrptionDelete | (optional) A description for Swagger documentation for DELETE operations for this address. |
Query String Parameters
RESTful requests for collections can be filtered using query stirng parameters.
...