REST API for Oracle Business Activity Monitoring

Retrieve Dashboards

get

/OracleBAMREST/api/projects/{projectname}/dashboards

Retrieves list of dashboards pertaining to given 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":[
        {
            "name":"ASN_TransacSummary_DeliveredDetails_DRL",
            "displayName":"ASN_TransacSummary_DeliveredDetails_DRL",
            "dashBoardBroken":"NOT_BROKEN",
            "dashBoardProxyUrl":"http://example.com:7001/bam/composer/faces/proxypage?project=BAMFramework&dashboard=ASN_TransacSummary_DeliveredDetails_DRL&DashboardParameters=(ASN_TransacSummary_Hour_Param=ALL;)",
            "businessViews":{
            },
            "links":[
                {
                    "rel":"self",
                    "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dashboards/ASN_TransacSummary_DeliveredDetails_DRL"
                }
            ]
        },
        {
            "name":"ASNDashBoardv2",
            "displayName":"ASNDashBoard",
            "dashBoardBroken":"NOT_BROKEN",
            "dashBoardProxyUrl":"http://example.com:7001/bam/composer/faces/proxypage?project=BAMFramework&dashboard=ASNDashBoardv2",
            "businessViews":{
            },
            "links":[
                {
                    "rel":"self",
                    "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dashboards/ASNDashBoardv2"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dashboards"
        }
    ]
}

Examples

The following example shows how to view a field name of a model defined for CaaS by submitting a GET request on the REST resource using cURL.

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

Example: Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Cache-Control: max-age=0
Content-Length: 857
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 the details of a field name of a model.

{
    "id": "CoreAttribute:1482768480334",
    "name": "Model",
    "description": "List Models description",
    "datatype": "text",
    "valuecount": "list",
    "createdby": "userName",
    "createddate": {
        "value": "2016-12-27T10:35:35.503Z",
        "timezone": "UTC",
        "description": ""
    },
    "updatedby": "userName",
    "updateddate": {
        "value": "2016-12-27T10:49:22.107Z",
        "timezone": "UTC",
        "description": ""
    },
    "properties": null,
    "links": [
        {
            "href": " https://<hostname>/content/management/api/v1/fields/Model",
            "rel": "self",
            "templated": false,
            "method": "PUT",
            "profile": "",
            "mediaType": ""
        },
        {
            "href": " https://<hostname>/content/management/api/v1/fields/Model",
            "rel": "canonical",
            "templated": false,
            "method": "PUT",
            "profile": "",
            "mediaType": ""
        },
        {
            "href": " https://<hostname>/content/management/api/v1/metadata-catalog/fields/Fuel1",
            "rel": "describedby",
            "templated": false,
            "method": "GET",
            "profile": "",
            "mediaType": "application/schema+json"
        }
    ]
}