1. REST API for Oracle Business Activity Monitoring
  2. Tasks
  3. Category Projects

Retrieve a Business View

get

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

Retrieves the business view details based on business view name.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body
Example Response (application/json)
{
    "isActive":true,
    "displayName":"ProcessStatus_BV",
    "subTitle":"by ProcessStatus",
    "id":"/project/BAMFramework/view/Chart4ProcessStatusv1",
    "drillObject":{
        "queryName":"InTeRnAlNaMeQuery__1416605431815_DeTaIlEd",
        "viewName":"InTeRnAlNaMeVIEW__1416605431815_DeTaIlEd",
        "fields":[
            "TrackingID",
            "ServiceId_SRC",
            "ServiceID_TGT",
            "BusinessKeyName",
            "BusinessKeyText",
            "ReceivedTimestamp",
            "DeliveredTimestamp",
            "DATAOBJECT_CREATED",
            "DATAOBJECT_MODIFIED"
        ],
        "parameters":[
            "InTeRnAlNaMeQuery__1416605431815_DeTaIlEd_ProcessStatus",
            "InTeRnAlNaMeQuery__1416605431815_DeTaIlEd_SendingApplication"
        ],
        "links":[
            {
                "rel":"businessview",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/businessviews/InTeRnAlNaMeVIEW__1416605431815_DeTaIlEd"
            },
            {
                "rel":"data",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/businessviews/InTeRnAlNaMeVIEW__1416605431815_DeTaIlEd/data"
            }
        ]
    },
    "name":"Chart4ProcessStatusv1",
    "layout":"LEGEND_ONLY",
    "businessQuery":{
        "id":"/project/BAMFramework/businessquery/Chart4ProcessStatus",
        "name":"Chart4ProcessStatus",
        "displayName":"ProcessStatus_BQ",
        "dataobjectName":"CommonAudit_DO",
        "type":"GROUP",
        "groups":[
            "ProcessStatus"
        ],
        "timeGrouping":{
            "columnName":null,
            "mode":null,
            "continuous":false,
            "units":null,
            "unit":null,
            "quantity":0
        }
    },
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/businessviews/Chart4ProcessStatusv1"
        }
    ],
    "title":"Shipment Status (Last 24 Hours )",
    "type":"PIE",
    "projectName":"BAMFramework",
    "data":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/businessviews/Chart4ProcessStatusv1/data"
            }
        ]
    },
    "drillHierarchy":"[]",
    "description":"BusinessViewDesc",
    "subType":"PIE"
}
Back to Top

Examples

The following example shows how the view type is defined for CaaS by submitting a GET request on a REST resource using cURL. 

curl -i -X GET https://<hostname>/content/management/api/v1/types/ModelType

Example: Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Cache-Control: max-age=0
Content-Length: 945
Content-Type: application/json
Date: Tue, 27 Dec 2016 10:37:59 GMT
Etag: " aa6c3797a837a2a8f98b3b6c5a2801c1a2905734fa01eea302bc667958b6f6e5"
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 type name ModelType. 

{
        "id": "CoreDef:1482768485034",
        "name": "ModelType",
        "description": "ModelType description",
        "createdby": "userName",
        "createddate":
        {
            "value": "2017-01-03T08:13:21.087Z",
            "timezone": "UTC",
            "description": ""
        },
        "updatedby": "userName",
        "updateddate":
        {
            "value": "2017-01-03T08:13:21.087Z",
            "timezone": "UTC",
            "description": ""
        },
        "fields":
        [
            {
                "name": "Model",
                "required": true,
                "settings": null,
                "link": null
            },
            {
                "name": "Year",
                "required": true,
                "settings": null,
                "link": null
            }
        ],
        "properties": null,
        "links":
        [
            {
                "href": "https://<hostname>/content/management/api/v1/types",
                "rel": "self",
                "templated": false,
                "method": "POST",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/types",
                "rel": "canonical",
                "templated": false,
                "method": "POST",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/metadata-catalog/types",
                "rel": "describedby",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": "application/schema+json"
            }
        ]
    }
Back to Top