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

Retrieve a Project

get

/OracleBAMREST/api/projects/{projectname}

Retrieves Project information based on project name.

Request

Query Parameters
  • The expand parameter can be used to specify that one or more child collection resource be expanded in place.
Back to Top

Response

Supported Media Types

200 Response

Success
Body
Example Response (application/json)
{
    "queries":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/queries"
            }
        ]
    },
    "displayName":"CommonAudit",
    "id":"/project/BAMFramework",
    "alerts":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/alerts"
            }
        ]
    },
    "dataObjects":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dataobjects"
            }
        ]
    },
    "name":"BAMFramework",
    "businessViews":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/businessviews"
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework"
        }
    ],
    "dashboards":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/dashboards"
            }
        ]
    },
    "parameters":{
        "links":[
            {
                "rel":"self",
                "href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/parameters"
            }
        ]
    }
}
Back to Top

Examples

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

curl -i -X GET http://<hostname>/content/published/api/v1/items?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu

Or

curl -i -X GET –H “access-token: Y2FhcyBkZWZhdWx0IHRva2Vu” http://<hostname>/content/published/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: 1325
Content-Type: application/json
Date: Wed, 11 Jan 2017 09:49:21 GMT
Etag: "57f8bc9ebbfb4d9436ed96458b2406ca203d0b4017be19c86fa9636856308321"
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 items searched from CaaS system. 

{
        "items":
        {
            "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": null,
						 "data" : {
           		     "Model": ""BMW Z4"
       		          "Year": 2015,
								}
            },
            "ModelType_core_b446f89e-1516-468f-9b7a-f483613641a2":
            {
                "id": "ModelType_core_b446f89e-1516-468f-9b7a-f483613641a2",
                "type": "ModelType",
                "name": "BMW",
                "description": "BMW model description",
                "createdby": "userName",
                "createddate":
                {
                    "value": "2017-01-03T10:28:28.690Z",
                    "timezone": "UTC",
                    "description": ""
                },
                "updatedby": "userName",
                "updateddate":
                {
                    "value": "2017-01-03T10:28:28.690Z",
                    "timezone": "UTC",
                    "description": ""
                },
                "links": null,
						 "data" : {
           		     "Model": "BMW 3-Series"
       		          "Year": 2016,
								}
           }
        },
        "links":
        [
            {
                "href": "https://<hostname>/content/published/api/v1/items/bulk?guids=ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef,ModelType_core_b446f89e-1516-468f-9b7a-f483613641a2",
                "rel": "self",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/published/api/v1/items/bulk?guids=ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef,ModelType_core_b446f89e-1516-468f-9b7a-f483613641a2",
                "rel": "canonical",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": ""
            },
            {
                "href": "https://<hostname>/content/published/api/v1/metadata-catalog/items/bulk",
                "rel": "describedby",
                "templated": false,
                "method": "GET",
                "profile": "",
                "mediaType": "application/schema+json"
            }
        ]
}
Back to Top