REST API for Oracle Business Activity Monitoring

Retrieve Business Queries

get

/OracleBAMREST/api/projects/{projectname}/queries/businessqueries

Retrieves list of business queries pertaining to a Project.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

Success

Example Response (application/json)

{
    "items":[
        {
            "id":"/project/BAMFramework/businessquery/Chart0DeliveredCount",
            "name":"Chart0DeliveredCount",
            "displayName":"DeliveredCount_BQ",
            "links":[
                {
                    "rel":"self",
                    "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/queries/businessqueries/Chart0DeliveredCount"
                }
            ]
        },
        {
            "id":"/project/BAMFramework/businessquery/ErrorCategory_DRL_BQ_v1",
            "name":"ErrorCategory_DRL_BQ_v1",
            "displayName":"ErrorCategory_DRL_BQ_v1",
            "links":[
                {
                    "rel":"self",
                    "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/queries/businessqueries/ErrorCategory_DRL_BQ_v1"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/queries/businessqueries"
        }
    ]
}

Examples

The following example shows how to search all items by submitting a GET request on the REST resource using cURL.

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

Example: Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Cache-Control: max-age=0
Content-Length: 1152
Content-Type: application/json
Date: Wed, 11 Jan 2017 08:54:01 GMT
Etag: "acfb56fa651bf70fd7f6e35bc94262f3661c77034b2e5d3b65bf8dc21269283b"
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 list of items searched from CaaS system.

{
        "hasMore": false,
        "limit": 2,
        "count": 2,
        "items":
        [
            {
                "id": "ModelType_core_b2313769-4573-429d-ab2e-23cea2f9f5ff",
                "description": "",
                "link":
                {
                    "href": "https://<hostname>/content/management/api/v1/items/ModelType_core_b2313769-4573-429d-ab2e-23cea2f9f5ff",
                    "rel": "Reference",
                    "templated": false,
                    "method": "GET",
                    "profile": "",
                    "mediaType": ""
                },
                "Model": "BMW Series",
                "Year": "2016"
            },
             {
                "id": "ModelType_core_b261389-4573-589d-af2e-28cea2f9f5ee",
                "description": "",
                "link":
                {
                    "href": "https://<hostname>/content/management/api/v1/items/ModelType_core_b261389-4573-589d-af2e-28cea2f9f5ee",
                    "rel": "Reference",
                    "templated": false,
                    "method": "GET",
                    "profile": "",
                    "mediaType": ""
                },
                "Model": "Honda Accord",
                "Year": "2017"
            }
        ],
        "links":
        [
            {
                "href": "https://<hostname>/content/management/api/v1/items",
                "rel": "self",
                "templated": false,
                "method": "",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/items",
                "rel": "canonical",
                "templated": false,
                "method": "",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/metadata-catalog/items",
                "rel": "describedby",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": "application/schema+json"
            },
            {
                "href": "https://<hostname>/content/management/api/v1/items?offset=0",
                "rel": "first",
                "templated": false,
                "method": "",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/management/api/v1/items?offset=0",
                "rel": "last",
                "templated": false,
                "method": "",
                "profile": "",
                "mediaType": ""
            }
        ],
        "offset": 0
    }