REST API - getDataViewDetails - uncategorized

The table summarizes the REST API - getDataViewDetails - uncategorized.

Request

Note: This returns all the data views that have been created using the web service API without specifying a category. If you create a data view in Openspace and Workspace without specifying a category, the BPM clients place them in a category called UNCATEGORIZED. Using the REST API getViewDetails does not return any data views created without a category in Openspace or Workspace.
Format 
GET <baseurl>/globaldata/dataviewcategory/uncategorized/getdataviewdetails
Query Parameters
  • 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.

Response

JSON Returns a JSON representation of the contents of a GetDataViewDetailsResponse element.
XML Returns the contents of a GetDataViewDetailsResponse element (from the BusinessDataServices schema)

Example

Request 
GET <baseurl>/globaldata/dataviewcategory/uncategorized/getdataviewdetails?includeAppDetails=true
Response 
{
        "result":
        {
            "viewID": 4,
            "specification":
            {
                "caseClassDetails":
                {
                    "caseClass": "com.example.hastings.Customer",
                    "majorVersion": 1
                },
                "name": "Customers",
                "description": "Current customers",
                "condition":
                {
                    "@type": "api:AttributeSearchCondition",
                    "attrPath": "accountNumber",
                    "operator": "EQ",
                    "value": "12*"
                }
            },
            "appDetails":
            {
                "name": "com.example.hastings-1",
                "majorVersion": 1
            }
        }
    }