Retrieve a Business Query
get
/OracleBAMREST/api/projects/{projectname}/queries/businessqueries/{businessqueryname}
Retrieves the business query details based on business query name.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
- application/xml
200 Response
Success
Example Response (application/json)
{
"query":{
"opaqueSql":"",
"systemManaged":false,
"selectedFields":[
],
"internal":false,
"groupFilter":{
"name":"groupFilter",
"type":"ALL",
"branches":[
],
"entries":[
],
"none":false
},
"displayName":"ErrorCategory_DRL_BQ_v1",
"createdDate":"2015-05-12T23:55:24.345+0000",
"runtimeFilter":{
"name":"runtimeFilter",
"type":"ALL",
"branches":[
],
"entries":[
],
"none":false
},
"topNEnabled":false,
"internalFilter":{
"name":"internalFilter",
"type":"ALL",
"branches":[
{
"name":null,
"type":"ANY",
"branches":[
],
"entries":[
{
"column":"ErrorType",
"lhsColumn":{
"name":"ErrorType",
"displayName":"Error Type"
},
"operator":"EQ",
"rhsValue":{
"value":"Permanent",
"beamObject":null
},
"isDateTimeLike":false,
"dateCompareMode":"DATETIME"
},
{
"column":"ErrorType",
"lhsColumn":{
"name":"ErrorType",
"displayName":"Error Type"
},
"operator":"EQ",
"rhsValue":{
"value":"Transient",
"beamObject":null
},
"isDateTimeLike":false,
"dateCompareMode":"DATETIME"
}
],
"none":false
}
],
"entries":[
{
"column":"CF_To_Extract_Year",
"lhsColumn":{
"name":"CF_To_Extract_Year",
"displayName":"CF_To_Extract_Year"
},
"operator":"EQ",
"rhsValue":{
"beamObject":{
"itemType":"Parameter",
"projectName":"BAMFramework",
"itemName":"ASN_DAYWISEVOL_YEAR_PARAM"
}
},
"isDateTimeLike":false,
"dateCompareMode":"DATETIME"
},
{
"column":"CF_To_Extract_Month",
"lhsColumn":{
"name":"CF_To_Extract_Month",
"displayName":"CF_To_Extract_Month"
},
"operator":"EQ",
"rhsValue":{
"beamObject":{
"itemType":"Parameter",
"projectName":"BAMFramework",
"itemName":"ASN_DAYWISEVOL_MONTH_PARAM"
}
},
"isDateTimeLike":false,
"dateCompareMode":"DATETIME"
},
{
"column":"CF_To_Extract_DAY",
"lhsColumn":{
"name":"CF_To_Extract_DAY",
"displayName":"CF_To_Extract_DAY"
},
"operator":"EQ",
"rhsValue":{
"beamObject":{
"itemType":"Parameter",
"projectName":"BAMFramework",
"itemName":"ASN_DAYWISEVOL_DAY_PARAM"
}
},
"isDateTimeLike":false,
"dateCompareMode":"DATETIME"
},
{
"column":"LAST_24_HOUR_DATE",
"lhsColumn":{
"name":"LAST_24_HOUR_DATE",
"displayName":"LAST_24_HOUR_DATE"
},
"operator":"LT",
"rhsValue":{
"value":"3",
"beamObject":null
},
"isDateTimeLike":false,
"dateCompareMode":"DATETIME"
}
],
"none":false
},
"dataObjectName":"CommonAudit_DO",
"id":"/project/BAMFramework/businessquery/ErrorCategory_DRL_BQ_v1",
"createdBy":"testuser",
"name":"ErrorCategory_DRL_BQ_v1",
"hierarchy":null,
"topN":"3",
"virtualDO":null,
"dataSourceName":"",
"opaque":false,
"modifiedBy":"testuser",
"type":"GROUP",
"topNMeasure":null,
"dataSeries":[
"COUNT(*)"
],
"modifiedDate":"2015-05-12T23:55:24.345+0000",
"projectName":"BAMFramework",
"labelSeries":[
"ErrorType"
],
"calculatedFields":[
],
"groups":[
"CF_To_Extract_DAY",
"CF_TO_EXTRACT_HOUR"
],
"description":null,
"timeGroupings":{
"entries":[
]
},
"sorts":{
"CF_To_Extract_DAY":"0",
"CF_TO_EXTRACT_HOUR":"0"
}
},
"links":[
{
"rel":"self",
"href":"http://example.com:7001/OracleBAMREST/api/projects/BAMFramework/queries/businessqueries/ErrorCategory_DRL_BQ_v1"
}
]
}Examples
The following example shows how to view published item by ID by submitting a GET request on the REST resource using cURL.
curl -i -X GET https://<hostname>/content/published/api/v1/items
Or
curl -i -X GET –H “access-token:Y2FhcyBkZWZhdWx0IHRva2Vu” https://<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: 1081 Content-Type: application/json Date: Tue, 03 Jan 2017 10:02:23 GMT Etag: "b56fbd1e969eecbfdb09aec23632494b6ca2a2cb5c2e6a7cd4099514d17ac6f0" 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 published item by ID: 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":
[
{
"href": "https://<hostname>/content/published/api/v1/items/ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef",
"rel": "self",
"templated": false,
"method": "PUT",
"profile": "",
"mediaType": ""
},
{
"href": "https://<publish>/content/published/api/v1/items/ModelType_core_65c6becf-08d1-4755-9d5e-cecd3eef34ef",
"rel": "canonical",
"templated": false,
"method": "PUT",
"profile": "",
"mediaType": ""
},
{
"href": "https://<hostname>/content/published/api/v1/metadata-catalog/items/",
"rel": "describedby",
"templated": false,
"method": "GET",
"profile": "",
"mediaType": "application/schema+json"
}
],
"data" : {
"Model": "BMW Z4"
"Year": 2015,
}
}Example: Published Digital Item
The following example shows how to view published item for the specified ID by submitting a GET request on the REST resource using cURL.
curl -i -X GET https://<hostname>/content/published/api/v1/items/DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu
Or
curl -i -X GET –H “access-token:Y2FhcyBkZWZhdWx0IHRva2Vu” https://<hostname>/content/published/api/v1/items/DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4
Example: Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Cache-Control: max-age=0 Content-Length: 1081 Content-Type: application/json Date: Tue, 03 Jan 2017 10:02:23 GMT Etag: "b56fbd1e969eecbfdb09aec23632494b6ca2a2cb5c2e6a7cd4099514d17ac6f0" 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 published item by ID: DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4..
{
"id": "DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4",
"type": "DigitalAsset",
"name": "audi_interior.jpg",
"description": "",
"createdby": "userName",
"createddate":
{
"value": "2016-08-19T21:24:38.000Z",
"timezone": "UTC",
"description": ""
},
"updatedby": "userName",
"updateddate":
{
"value": "2016-08-19T21:24:38.000Z",
"timezone": "UTC",
"description": ""
},
"links":
[
{
"href": "https://<hostname>/content/published/api/v1/items/DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu",
"rel": "self",
"templated": false,
"method": "GET",
"profile": "",
"mediaType": ""
},
{
"href": "https://<hostname>/content/published/api/v1/items/DigitalAsset_proxy_6fec326c-34b9-4678-b322-7defe259feb4?access-token=Y2FhcyBkZWZhdWx0IHRva2Vu",
"rel": "canonical",
"templated": false,
"method": "GET",
"profile": "",
"mediaType": ""
},
{
"href": "https://<hostname>/content/published/api/v1/metadata-catalog/items",
"rel": "describedby",
"templated": false,
"method": "GET",
"profile": "",
"mediaType": "application/schema+json"
}
],
"size": 98292,
"additionalproperties":
{
},
"renditions":
{
"default": "https://<hostname>/content/published/api/v1/digital/DigitalAsset_proxy_befdfc56-5a04-40fe-93fe-5921092ee5c5/?rendition=default",
"thumbnail": "https://<hostname>/content/published/api/v1/digital/DigitalAsset_proxy_befdfc56-5a04-40fe-93fe-5921092ee5c5/?rendition=thumbnail"
},
"mimeType": "image/jpeg",
"version": "1",
"fileType": "jpeg"
}