{ "basePath":"/OracleBAMREST/bam/api", "info":{ "title":"Oracle Business Activity Monitoring REST API", "version":"2016.06.27", "description":"Business Activity monitoring API", "x-summary":"Business Activity monitoring API" }, "paths":{ "/projects/{projectname}/queries/businessqueries/parameters":{ "get":{ "description":" Retrieves type of Parameters supported by BAM.", "summary":"Retrieve Parameters", "operationId":"get /projects/{projectname}/queries/businessqueries/parameters", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "resource":"valueparameters", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters/valueparameters" } ] }, { "resource":"listparameters", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters/listparameters" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-parameters-get" } }, "/projects/{projectname}/queries/businessqueries/alerts":{ "get":{ "description":" Retrieves list of alerts pertaining to Project.", "summary":"Retrieve Alerts", "operationId":"get /projects/{projectname}/queries/businessqueries/alerts", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "id":"/project/BAMFramework/alert/ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert", "name":"ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert", "displayName":"ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/alerts/ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert" } ] }, { "id":"/project/BAMFramework/alert/KPI_Purging_Email_CommonAudit_HIGH_Alert", "name":"KPI_Purging_Email_CommonAudit_HIGH_Alert", "displayName":"KPI_Purging_Email_CommonAudit_HIGH_Alert", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/alerts/KPI_Purging_Email_CommonAudit_HIGH_Alert" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/alerts" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-alerts-get" } }, "/projects/{projectname}/queries/businessqueries/parameters/valueparameters":{ "get":{ "description":" Retrieves list of value parameters pertaining to Project.", "summary":"Retrieve Value Parameters", "operationId":"get /projects/{projectname}/queries/businessqueries/parameters/valueparameters", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "id":"/project/BAMFramework/parameter/ASN_ErrorCategory_ErrorType_DRL", "name":"ASN_ErrorCategory_ErrorType_DRL", "displayName":"ASN_ErrorCategory_ErrorType_DRL", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters/valueparameters/ASN_ErrorCategory_ErrorType_DRL" } ] }, { "id":"/project/BAMFramework/parameter/ASN_DAYWISEVOL_DAY_PARAM", "name":"ASN_DAYWISEVOL_DAY_PARAM", "displayName":"ASN_DAYWISEVOL_DAY_PARAM", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters/valueparameters/ASN_DAYWISEVOL_DAY_PARAM" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters/valueparameters" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-parameters-valueparameters-get" } }, "/projects":{ "get":{ "description":" Retrieves list of Projects in BAM.", "summary":"Retrieve Projects", "operationId":"get /projects", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ { "type":"integer", "name":"limit", "in":"query", "description":"Maximum number of items per page. Set between 1 and 100. Default is 25.", "required":false } ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "queries":{ }, "displayName":"Process Analytics", "id":"/project/BPMAnalytics", "alerts":{ }, "dataObjects":{ }, "name":"BPMAnalytics", "businessViews":{ }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BPMAnalytics" } ], "dashboards":{ }, "parameters":{ } } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-get" } }, "/projects/{projectname}/queries":{ "get":{ "description":" List the type of queries which are supported by BAM.", "summary":"Retrieve Queries", "operationId":"get /projects/{projectname}/queries", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "resource":"businessqueries", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/queries/businessqueries" } ] }, { "resource":"continuousqueries", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/queries/continuousqueries" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/queries" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-get" } }, "/projects/{projectname}/queries/businessqueries/continuousqueries/{continuousqueryname}":{ "get":{ "description":" Retrieves the continuous query details based on continuous query name.", "summary":"Retrieve a Continuous Query", "operationId":"get /projects/{projectname}/queries/businessqueries/continuousqueries/{continuousqueryname}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "query":{ "simpleNorm":true, "systemManaged":false, "refreshTime":null, "internal":false, "deviationTimes":1, "timestampField":null, "aggregationFunction":null, "activeEnable":false, "normTimeUnit":"SQL_TSI_DAY", "normEveryTimeUnit":"day", "displayName":"removeme", "createdDate":"2015-05-08T09:54:09.885+0000", "measureField":null, "groupby":[ ], "id":"/project/TimeSeries_DatetimeDrilling/continuousquery/removeme", "partitionByCalculatedField":{ }, "calculatedField":{ }, "createdBy":"testuser", "normFunction":"AVG", "rollingWindow":null, "name":"removeme", "outputs":[ ], "mesureField":null, "percentDeviation":false, "simpleDeviation":true, "alertCondition":null, "opaque":false, "modifiedBy":"testuser", "templateName":"kpi_alert_template", "normValue":1, "filterString":null, "historicalNorm":false, "opaqueCql":null, "calDeviation":false, "CQLStatement":null, "modifiedDate":"2015-05-08T09:54:09.885+0000", "normEveryTime":1, "normTime":1, "deviationPercent":0.01, "normName":"simple", "projectList":null, "groupbyCalculatedField":{ "entries":[ ] }, "deviationFunction":"STDDEV", "deviationValue":1, "description":null, "dataObject":null }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/TimeSeries_DatetimeDrilling/queries/continuousqueries/removeme" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-continuousqueries-{continuousqueryname}-get" } }, "/projects/{projectname}/businessviews/{businessviewname}":{ "get":{ "description":" Retrieves the business view details based on business view name.", "summary":"Retrieve a Business View", "operationId":"get /projects/{projectname}/businessviews/{businessviewname}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "isActive":true, "displayName":"ProcessStatus_BV", "subTitle":"by ProcessStatus", "id":"/project/BAMFramework/view/Chart4ProcessStatusv1", "drillObject":{ "queryName":"InTeRnAlNaMeQuery__1416605431815_DeTaIlEd", "viewName":"InTeRnAlNaMeVIEW__1416605431815_DeTaIlEd", "fields":[ "TrackingID", "ServiceId_SRC", "ServiceID_TGT", "BusinessKeyName", "BusinessKeyText", "ReceivedTimestamp", "DeliveredTimestamp", "DATAOBJECT_CREATED", "DATAOBJECT_MODIFIED" ], "parameters":[ "InTeRnAlNaMeQuery__1416605431815_DeTaIlEd_ProcessStatus", "InTeRnAlNaMeQuery__1416605431815_DeTaIlEd_SendingApplication" ], "links":[ { "rel":"businessview", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews/InTeRnAlNaMeVIEW__1416605431815_DeTaIlEd" }, { "rel":"data", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews/InTeRnAlNaMeVIEW__1416605431815_DeTaIlEd/data" } ] }, "name":"Chart4ProcessStatusv1", "layout":"LEGEND_ONLY", "businessQuery":{ "id":"/project/BAMFramework/businessquery/Chart4ProcessStatus", "name":"Chart4ProcessStatus", "displayName":"ProcessStatus_BQ", "dataobjectName":"CommonAudit_DO", "type":"GROUP", "groups":[ "ProcessStatus" ], "timeGrouping":{ "columnName":null, "mode":null, "continuous":false, "units":null, "unit":null, "quantity":0 } }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews/Chart4ProcessStatusv1" } ], "title":"Shipment Status (Last 24 Hours )", "type":"PIE", "projectName":"BAMFramework", "data":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews/Chart4ProcessStatusv1/data" } ] }, "drillHierarchy":"[]", "description":"BusinessViewDesc", "subType":"PIE" } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-businessviews-{businessviewname}-get" } }, "/projects/{projectname}/dashboards":{ "get":{ "description":" Retrieves list of dashboards pertaining to given Project.", "summary":"Retrieve Dashboards", "operationId":"get /projects/{projectname}/dashboards", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "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/bam/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/bam/api/projects/BAMFramework/dashboards/ASNDashBoardv2" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/dashboards" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-dashboards-get" } }, "/projects/{projectname}/queries/businessqueries/alerts/{alertname}":{ "get":{ "description":" Retrieves the Alert details based on alert name.", "summary":"Retrieve an Alert", "operationId":"get /projects/{projectname}/queries/businessqueries/alerts/{alertname}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "alert":{ "oEvent":{ "oContinuousQueryName":"BAMFramework.ASN_KPI_SLAViolation_Email_Alerting_HIGHAlert_ScheduledQuery", "oContinuousQueryString":"CREATE SCHEDULED QUERY BAMFramework.ASN_KPI_SLAViolation_Email_Alerting_HIGHAlert_ScheduledQuery AS \"SELECT SUMSLAViolationForKPI AS KPI_MEASURE, 10 AS KPI_THRESHOLD, 'ASN_KPI_SLAViolation_Email_Alerting' AS KPI_NAME, '/project/BAMFramework/kpi/ASN_KPI_SLAViolation_Email_Alerting' AS KPI_ID, 'HIGH' AS KPI_RISK_STATUS, CAST(CURRENT_TIMESTAMP AS TIMESTAMP) AS KPI_TIMESTAMP FROM ( SELECT SUM(CASE WHEN ( (((CAST(DeliveredTimestamp AS DATE) - CAST(ReceivedTimestamp AS DATE)) * 24 * 60 * 60) >300 ) ) THEN (1) ELSE (0) END) AS SUMSLAViolationForKPI FROM BEAM_VIEW_68 WHERE ( (DeliveredTimestamp IS NOT NULL ) AND ((((CAST(LOCALTIMESTAMP AS DATE) - CAST(DATAOBJECT_CREATED AS DATE)) * 24 * 60 * 60) /60)<60 ) ) HAVING (SUM(CASE WHEN ( (((CAST(DeliveredTimestamp AS DATE) - CAST(ReceivedTimestamp AS DATE)) * 24 * 60 * 60) >300 ) ) THEN (1) ELSE (0) END)>(10.0+10) ) ) S1\" REFRESH ON \"2015/03/12 02:37:00 PM -0700\" EVERY 1 DAY START IMMEDIATE destination \"jms:queue/oracle.beam.cqservice.mdbs.alertengine:queuecf/oracle.beam.cqservice.mdbs.alertengine?batch=true\"", "m_strKPIId":"/project/BAMFramework/kpi/ASN_KPI_SLAViolation_Email_Alerting", "m_strRangeType":"HIGH" }, "systemManaged":false, "internal":false, "strAlertXml":" KPI CQL BAMFramework.ASN_KPI_SLAViolation_Email_Alerting_HIGHAlert_ScheduledQuery 300 ) ) THEN (1) ELSE (0) END) AS SUMSLAViolationForKPI FROM BEAM_VIEW_68 WHERE ( (DeliveredTimestamp IS NOT NULL ) AND ((((CAST(LOCALTIMESTAMP AS DATE) - CAST(DATAOBJECT_CREATED AS DATE)) * 24 * 60 * 60) /60)<60 ) ) HAVING (SUM(CASE WHEN ( (((CAST(DeliveredTimestamp AS DATE) - CAST(ReceivedTimestamp AS DATE)) * 24 * 60 * 60) >300 ) ) THEN (1) ELSE (0) END)>(10.0+10) ) ) S1\" REFRESH ON \"2015/03/12 02:37:00 PM -0700\" EVERY 1 DAY START IMMEDIATE destination \"jms:queue/oracle.beam.cqservice.mdbs.alertengine:queuecf/oracle.beam.cqservice.mdbs.alertengine?batch=true\"]]> /project/BAMFramework/kpi/ASN_KPI_SLAViolation_Email_Alerting HIGH notify Send ganesh.rajendran@nike.com,amik.basu@nike.com SMTP ", "bIsKPIAlert":true, "displayName":null, "createdDate":"2015-05-12T23:55:47.015+0000", "oActionList":[ { "oSelectedActions":{ "entries":[ { "key":"MESSAGE_EMAIL", "value":{ "strEmail":"ganesh.rajendran@nike.com,amik.basu@nike.com", "strMessageText":"BAM Alert-Common Audit SLA violation count exceeds 20. Appropriate action should be taken.\n\nRegards\nBAMAdmin\n", "strMessageSubject":"DEVELOPMENT ENVIRONMENT-BAM Alert : CommonAudit SLA Violation [Date/Time Sent] ", "oMessageSubjectElements":[ { "strType":"text", "strValue":"DEVELOPMENT ENVIRONMENT-BAM Alert : CommonAudit SLA Violation ", "strDisplayValue":null }, { "strType":"DateTimeElement", "strValue":"Date/Time Sent", "strDisplayValue":null }, { "strType":"text", "strValue":"", "strDisplayValue":null } ], "oMessageTextElements":[ { "strType":"text", "strValue":"BAM Alert-Common Audit SLA violation count exceeds 20. Appropriate action should be taken.\n\nRegards\nBAMAdmin\n", "strDisplayValue":null } ] } } ] }, "oConstraint":{ "oStartTime":null, "oDayOfWeek":[ "MONDAY" ], "oFromDateTime":null, "bIsParticularDayOfWeekCondition":false, "bIsBetweenTwoDaysCondition":false, "bIsFromDateSet":true, "oEndTime":null, "oToDateTime":null, "bIsBetweenTwoTimeCondition":false, "bIsToDateSet":true, "oSelectedDayOfWeek":[ "MONDAY" ] } } ], "id":"/project/BAMFramework/alert/ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert", "createdBy":"testuser", "name":"ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert", "modifiedBy":"testuser", "bIsActive":true, "modifiedDate":"2015-05-12T23:55:47.015+0000", "description":"HIGH alert for KPI ASN_KPI_SLAViolation_Email_Alerting" }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/alerts/ASN_KPI_SLAViolation_Email_Alerting_HIGH_Alert" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-alerts-{alertname}-get" } }, "/projects/{projectname}/queries/businessqueries/parameters/listparameters":{ "get":{ "description":" Retrieves list parameters pertaining to Project.", "summary":"Retrieve List Parameters", "operationId":"get /projects/{projectname}/queries/businessqueries/parameters/listparameters", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "id":"/project/Sample2/parameter/ListParam1", "name":"ListParam1", "displayName":"ListParam1", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/Sample2/parameters/listparameters/ListParam1" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/Sample2/parameters/listparameters" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-parameters-listparameters-get" } }, "/projects/{projectname}/queries/businessqueries":{ "get":{ "description":" Retrieves list of business queries pertaining to a Project.", "summary":"Retrieve Business Queries ", "operationId":"get /projects/{projectname}/queries/businessqueries", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "id":"/project/BAMFramework/businessquery/Chart0DeliveredCount", "name":"Chart0DeliveredCount", "displayName":"DeliveredCount_BQ", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/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/bam/api/projects/BAMFramework/queries/businessqueries/ErrorCategory_DRL_BQ_v1" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/queries/businessqueries" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-get" } }, "/projects/{projectname}/businessviews/{businessviewname}/data":{ "get":{ "description":" Retrieve the records which are obtained by running the business query pertaining to given business view .", "summary":"Retrieve Business View data", "operationId":"get /projects/{projectname}/businessviews/{businessviewname}/data", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "COUNTEventTypeCode_Recv":[ { "x":"1-In Flight", "y":34 }, { "x":"2-Discarded", "y":18 }, { "x":"3-Delivered", "y":244 }, { "x":"4-Failed", "y":34 } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-businessviews-{businessviewname}-data-get" }, "post":{ "description":" Retrieve the records which are by obtained by filtering the query results based on groups,parameters or filters.", "summary":"Retrieve Business View data using filter", "operationId":"post /projects/{projectname}/businessviews/{businessviewname}/data", "produces":[ "application/json", "application/xml" ], "consumes":[ "application/json", "application/xml" ], "parameters":[ { "x-examples":{ "application/json":{ "groups":[ "Country" ], "filters":[ { "name":"Dept", "value":"HR" }, { "name":"Salary_int", "value":"150" } ], "parameters":[ { "name":"Dept", "value":"HR" }, { "name":"Salary_int", "value":"150" } ] } }, "schema":{ "$ref":"#/definitions/data" }, "name":"body", "in":"body", "description":"", "required":false } ], "responses":{ "200":{ "examples":{ "application/json":[ { "DATAOBJECT_MODIFIED":"2014-03-11T14:54:57.821+0000", "DATAOBJECT_CREATED":"2014-03-11T14:54:57.821+0000", "Salary_decimal":1000.555, "Dept":"HR", "Salary_float":100.55, "Salary_int":100 }, { "DATAOBJECT_MODIFIED":"2014-03-11T14:54:57.821+0000", "DATAOBJECT_CREATED":"2014-03-11T14:54:57.821+0000", "Salary_decimal":200.22, "Dept":"HR", "Salary_float":150.323, "Salary_int":150 } ] }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-businessviews-{businessviewname}-data-post" } }, "/projects/{projectname}/businessviews":{ "get":{ "description":" Retrieves list of business views pertaining to a given Project.", "summary":"Retrieve Business Views", "operationId":"get /projects/{projectname}/businessviews", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "name":"Chart4ProcessStatusv1", "displayName":"ProcessStatus_BV", "isActive":false, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews/Chart4ProcessStatusv1" } ] }, { "name":"TransactionSummary_Received_DRL_BV", "displayName":"TransactionSummary_Received_DRL_BV", "isActive":false, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews/TransactionSummary_Received_DRL_BV" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-businessviews-get" } }, "/projects/{projectname}/queries/businessqueries/parameters/listparameters/{listparametername}":{ "get":{ "description":" Retrieves the List Parameter details based on list parameter name.", "summary":"Retrieve a List Parameter", "operationId":"get /projects/{projectname}/queries/businessqueries/parameters/listparameters/{listparametername}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "parameter":{ "sourceColumnName":"name1", "systemManaged":false, "internal":false, "inDataObject":false, "displayName":"ListParam1", "createdDate":"2015-05-18T10:23:28.337+0000", "id":"/project/Sample2/parameter/ListParam1", "createdBy":"testuser", "name":"ListParam1", "value":[ ], "modifiedBy":"testuser", "required":true, "dataType":"VARCHAR", "enableStaticOptions":false, "defaultValue":[ "ALL" ], "modifiedDate":"2015-05-18T10:23:28.337+0000", "options":[ "ALL", "NULL", "BLANK", "asas", "sdsd" ], "sourceDataObjectName":"Sample2", "description":null, "multiple":true }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/Sample2/parameters/listparameters/ListParam1" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-parameters-listparameters-{listparametername}-get" } }, "/projects/{projectname}/queries/businessqueries/parameters/valueparameters/{valueparametername}":{ "get":{ "description":" Retrieves the Value Parameter details based on value parameter name.", "summary":"Retrieve a Value parameter", "operationId":"get /projects/{projectname}/queries/businessqueries/parameters/valueparameters/{valueparametername}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "parameter":{ "systemManaged":false, "internal":false, "inDataObject":false, "displayName":"ASN_DAYWISEVOL_YEAR_PARAM", "createdDate":"2015-05-12T23:55:24.303+0000", "id":"/project/BAMFramework/parameter/ASN_DAYWISEVOL_YEAR_PARAM", "createdBy":"testuser", "name":"ASN_DAYWISEVOL_YEAR_PARAM", "value":{ "beamObject":null }, "modifiedBy":"testuser", "required":true, "dataType":"INT", "defaultValue":{ "beamObject":null }, "modifiedDate":"2015-05-12T23:55:24.303+0000", "description":null }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters/valueparameters/ASN_DAYWISEVOL_YEAR_PARAM" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-parameters-valueparameters-{valueparametername}-get" } }, "/projects/{projectname}/queries/businessqueries/{businessqueryname}":{ "get":{ "description":" Retrieves the business query details based on business query name.", "summary":"Retrieve a Business Query", "operationId":"get /projects/{projectname}/queries/businessqueries/{businessqueryname}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "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/bam/api/projects/BAMFramework/queries/businessqueries/ErrorCategory_DRL_BQ_v1" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-{businessqueryname}-get" } }, "/projects/{projectname}/dataobjects":{ "get":{ "description":" Retrieves list of dataobjects pertaining to a given Project.", "summary":"Retrieve Data Objects", "operationId":"get /projects/{projectname}/dataobjects", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "id":"/dataobject/CommonAudit_Error_DO", "name":"CommonAudit_Error_DO", "displayName":"/oracle/BAMProcess/CommonAudit_Error_DO", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/dataobjects/simpledataobjects/CommonAudit_Error_DO" } ] }, { "id":"/dataobject/CommonAudit_DO", "name":"CommonAudit_DO", "displayName":"/oracle/BAMProcess/CommonAudit_DO", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/dataobjects/simpledataobjects/CommonAudit_DO" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/dataobjects" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-dataobjects-get" } }, "/projects/{projectname}/queries/businessqueries/continuousqueries":{ "get":{ "description":" Retrieves list of continuous queries pertaining to a Project.", "summary":"Retrieve Continuous Queries", "operationId":"get /projects/{projectname}/queries/businessqueries/continuousqueries", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "application/json":{ "items":[ { "id":"/project/TimeSeries_DatetimeDrilling/continuousquery/removeme", "name":"removeme", "displayName":"removeme", "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/TimeSeries_DatetimeDrilling/queries/continuousqueries/removeme" } ] } ], "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/TimeSeries_DatetimeDrilling/queries/continuousqueries" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-queries-businessqueries-continuousqueries-get" } }, "/projects/{projectname}/dashboards/{dashboardname}":{ "get":{ "description":" Retrieves the Dashboard details based on Dashboard name.", "summary":"Retrieve a Dashboard", "operationId":"get /projects/{projectname}/dashboards/{dashboardname}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ ], "responses":{ "200":{ "examples":{ "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/bam/api/projects/BAMFramework/dashboards/ASNDashBoardv2/businessviews" } ] }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/dashboards/ASNDashBoardv2" } ] } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-dashboards-{dashboardname}-get" } }, "/projects/{projectname}":{ "get":{ "description":" Retrieves Project information based on project name.", "summary":"Retrieve a Project", "operationId":"get /projects/{projectname}", "produces":[ "application/json", "application/xml" ], "consumes":[ ], "parameters":[ { "name":"expand", "in":"query", "description":"The expand parameter can be used to specify that one or more child collection resource be expanded in place.", "required":false } ], "responses":{ "200":{ "examples":{ "application/json":{ "queries":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/queries" } ] }, "displayName":"CommonAudit", "id":"/project/BAMFramework", "alerts":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/alerts" } ] }, "dataObjects":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/dataobjects" } ] }, "name":"BAMFramework", "businessViews":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/businessviews" } ] }, "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework" } ], "dashboards":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/dashboards" } ] }, "parameters":{ "links":[ { "rel":"self", "href":"http://example.com:7001/OracleBAMREST/bam/api/projects/BAMFramework/parameters" } ] } } }, "schema":{ }, "description":"Success" } }, "tags":[ "Category Projects" ], "x-internal-id":"projects-{projectname}-get" } } }, "definitions":{ "data":{ "type":"object", "$schema":"http://json-schema.org/draft-03/schema", "id":"http://jsonschema.net", "required":false, "properties":{ "parameters":{ "type":"array", "required":false, "items":[ { "type":"object", "properties":{ "name":{ "type":"string", "required":true }, "value":{ "type":"string", "required":true } } } ] }, "groups":{ "type":"array", "required":false, "items":[ { "type":"string" } ] }, "filters":{ "type":"array", "required":false, "items":[ { "type":"object", "properties":{ "name":{ "type":"string", "required":true }, "value":{ "type":"string", "required":true } } } ] } } } }, "swagger":"2.0", "tags":[ { "name":"Category Projects", "description":"Projects endpoint for BAM API" } ] }