REST API - getDataViewDetails - caseType

GET <baseurl>/globaldata/model/<caseType>/<version>/getdataviewdetails

• caseType. The case type is the fully qualified name of the case class. For example, com.example.gddemo.Car. Can be obtained using getCaseClassInfo.
• Version. The current version number of the deployed application.

• viewDetailsRequirement=string (optional). Specifies that the response contains only a limited amount of information, rather than the full details of the data view. The valid values are:
  • NAME - Returns only the name of the specified data view.
  • NAME_AND_DESCRIPTON - Returns only the name and description of the specified data view.
  • NAME_AND_PARAMETERS - Returns only the name of the specified data view, as well as its named parameters, their data types, and multiplicity*.
  • NAME_DESCRIPTION_AND_PARAMETERS - Returns only the name and description of the specified data view, as well as its named parameters, their data types, and multiplicity*.

  See also: Determining a Data View's Named Parameters.

  * The multiplicity is the number of values required for the named parameter (ONE, TWO, or MANY). If omitted, assume ONE (as this is the case most of the time, the server does not return it so as not to clutter the response). If the condition uses the operators BETWEEN or NOT_BETWEEN, the multiplicity will be TWO (a BETWEEN condition has two values: the upper and lower bounds). For IN and NOT_IN operators, the multiplicity will be MANY.

• includeAppDetails=boolean (optional, default=false) - If true, the response includes details of the application with which the view is associated.
• includeCategories=boolean (optional, default=false) - If true, the response includes details of the categories to which the view belongs.

GET <baseurl>/globaldata/model/com.example.hastings.Order/1/getdataviewdetails?includeAppDetails=trues

{
        "result":
        {
            "viewID": 2,
            "specification":
            {
                "caseClassDetails":
                {
                    "caseClass": "com.example.hastings.Order",
                    "majorVersion": 1
                },
                "name": "Large orders",
                "description": "Orders over $10,000",
                "condition":
                {
                    "@type": "api:AttributeSearchCondition",
                    "attrPath": "lineItems[ANY].price",
                    "operator": "GT",
                    "value": 10000
                }
            },
            "appDetails":
            {
                "name": "com.example.hastings-1",
                "majorVersion": 1
            }
        }
    }