Jump to

• Request
• Response
• Examples

Retrieve Business View Data Using Filter

post

/OracleBAMREST/api/projects/{projectname}/businessviews/{businessviewname}/data

Retrieves the records that are by obtained by filtering the query results based on groups, parameters, or filters.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Root Schema : data

Type: object

Show Source

• filters(optional): array filters
• groups(optional): array groups
• parameters(optional): array parameters

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/propertiesItem"
            }
        },
        "groups":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/propertiesItem"
            }
        }
    }
}

Nested Schema : filters

Type: array

Show Source

• Array of: object propertiesItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/propertiesItem"
    }
}

Nested Schema : groups

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object propertiesItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/propertiesItem"
    }
}

Nested Schema : propertiesItem

Type: object

Show Source

• name: string
• value: string

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body

Example Response (application/json)

[
    {
        "DATAOBJECT_MODIFIED":"2014-03-11T14:54:57.821+0000",
        "DATAOBJECT_CREATED":"2014-03-11T14:54:57.821+0000",
        "Salary_decimal":1000.555,
        "Dept":"HR",
        "Salary_float":100.55,
        "Salary_int":100
    },
    {
        "DATAOBJECT_MODIFIED":"2014-03-11T14:54:57.821+0000",
        "DATAOBJECT_CREATED":"2014-03-11T14:54:57.821+0000",
        "Salary_decimal":200.22,
        "Dept":"HR",
        "Salary_float":150.323,
        "Salary_int":150
    }
]

Back to Top

Examples

The following example shows how to view item by GUID by submitting a GET request on the REST resource using cURL.

curl -i -X GET https://<hostname>/content/management/api/v1/items/ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef

Example: Response Header

The following shows an example of the response header when you update an item.

HTTP/1.1 200 OK
Cache-Control: max-age=0
Content-Length: 1081
Content-Type: application/json
Date: Tue, 03 Jan 2017 10:02:23 GMT
Etag: "b56fbd1e969eecbfdb09aec23632494b6ca2a2cb5c2e6a7cd4099514d17ac6f0"
Server: Apache-Coyote/1.1
X-XSS-Protection: 1
x-content-type-options: nosniff

Example: Response Body

The following is an example of the response returned in JSON format. It shows details of each item by GUID: ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef.

    {
        "id": "ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef",
        "type": "ModelType",
        "name": "BMW",
        "description": "BMW model description",
        "createdby": "userName",
        "createddate":
        {
            "value": "2017-01-03T09:48:56.110Z",
            "timezone": "UTC",
            "description": ""
        },
        "updatedby": "userName",
        "updateddate":
        {
            "value": "2017-01-03T10:02:21.360Z",
            "timezone": "UTC",
            "description": ""
        },
        "links":
        [
            {
                "href": "https://<hostname>/content/management/api/v1/items/ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef",
                "rel": "self",
                "templated": false,
                "method": "PUT",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/items/ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef",
                "rel": "canonical",
                "templated": false,
                "method": "PUT",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/metadata-catalog/items",
                "rel": "describedby",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": "application/schema+json"
            }
        ],
			"data" : {
       		  "Year": 2015,
      		  "Model": "BMW Z4"
    }
}

Back to Top