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

Retrieve a Dashboard

get

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

Retrieves the Dashboard details based on Dashboard 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)
{
    "id":"/project/BAMFramework/dashboard/ASNDashBoardv2",
    "name":"ASNDashBoardv2",
    "displayName":"ASNDashBoard",
    "title":"
RETAILER ASN DASHBOARD
",
    "type":"simple",
    "businessViews":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dashboards/ASNDashBoardv2/businessviews"
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dashboards/ASNDashBoardv2"
        }
    ]
}
Back to Top

Examples

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

curl -i -X GET https://<hostname>/content/published/api/v1/items?field:type:equals=DigitalAsset&access-token=Y2FhcyBkZWZhdWx0IHRva2Vu&fields=caasPublishDates,caasPublishTargets,updateddate&caasPublishDates:gte=28-03-1989

Or

curl -i -X GET -H "access-token: Y2FhcyBkZWZhdWx0IHRva2Vu"  https://<hostname>/content/published/api/v1/items?field:type:equals=DigitalAsset&fields=caasPublishDates,caasPublishTargets,updateddate&caasPublishDates:gte=28-03-1989

Example: Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Cache-Control: max-age=0
Content-Length: 1830
Content-Type: application/json
Date: Wed, 11 Jan 2017 09:34:07 GMT
Etag: "8f8b7c6b15f3ab6cdf857ef4d22d4f4678e3723a33d423798bf556d94feb5208"
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 published digital items for a specific type (DigitalAssets) searched from CaaS system. 

{
        "offset": 0,
        "limit": 1,
        "count": 1,
        "hasMore": false,
        "links":
        [
            {
                "href": "http://<hostname>/content/published/api/v1/types/DigitalAsset/items?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu&fields=caasPublishDates,caasPublishTargets,updateddate&caasPublishDates:gte=28-03-1989",
                "rel": "self",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "http://<hostname>/content/published/api/v1/types/DigitalAsset/items?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu&fields=caasPublishDates,caasPublishTargets,updateddate&caasPublishDates:gte=28-03-1989",
                "rel": "canonical",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "http://<hostname>/content/published/api/v1/metadata-catalog/types/DigitalAsset/items",
                "rel": "describedby",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": "application/schema+json"
            },
            {
                "href": "http://<hostname>/content/published/api/v1/types/DigitalAsset/items?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu&fields=caasPublishDates,caasPublishTargets,updateddate&caasPublishDates:gte=28-03-1989&offset=0",
                "rel": "first",
                "templated": false,
                "method": "",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "http://<hostname>/content/published/api/v1/types/DigitalAsset/items?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu&fields=caasPublishDates,caasPublishTargets,updateddate&caasPublishDates:gte=28-03-1989&offset=0",
                "rel": "last",
                "templated": false,
                "method": "",
                "profile": "",
                "mediaType": ""
            }
        ],
        "items":
        [
            {
                "caasPublishDates": "20170111070322043 ",
                "link":
                {
                    "href": "http://<hostname>/content/published/api/v1/items/DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4",
                    "rel": "Reference",
                    "templated": false,
                    "method": "GET",
                    "profile": "",
                    "mediaType": ""
                },
                "caasPublishTargets": "default",
                "updateddate": "20160819212438000 ",
                "id": "DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4",
                "type": "DigitalAsset"
            }
        ]
}
Back to Top