{"swagger":"2.0","info":{"version":"Test","title":"AAI REST API Documentation for Business Measures","description":"This document provides details about REST APIs available for Business Measures","contact":{"name":"AAI Development team"}},"host":"whf00bih:8888","basePath":"/ummservice-ui/rest-api/umm/v1","schemes":["http"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/measure/summary":{"post":{"tags":["summary"],"description":"Returns summary of all Business Measures present in an infodom based on search parameters","operationId":"businessMeasures","produces":["application/json"],"parameters":[{"name":"summaryparam","in":"body","description":"Parameters to filter Summary","required":true,"schema":{"$ref":"#/definitions/summaryparams"}}],"responses":{"200":{"description":"summary response","type":"object","schema":{"$ref":"#/definitions/summaryPayload"}},"204":{"description":"No content"},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/ErrorPayload"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/ErrorPayload"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/ErrorPayload"}}}}},"/measure/detail":{"post":{"tags":["detail"],"description":"Returns details of a Business Measure available in an infodom","operationId":"businessMeasuresDetail","produces":["application/json"],"parameters":[{"name":"detailparam","in":"body","description":"Parameters to select a Business Measure","required":true,"schema":{"$ref":"#/definitions/detailparams"}}],"responses":{"200":{"description":"Detailed Object for Business Measure","type":"object","schema":{"$ref":"#/definitions/payloadMsrObj"}},"204":{"description":"No content"},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/ErrorPayload"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/ErrorPayload"}},"404":{"description":"Not found, Unable to find object in the infodom","schema":{"$ref":"#/definitions/ErrorPayload"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/ErrorPayload"}}}}},"/metadata/expression":{"post":{"tags":["expression"],"description":"Return expression for given metadata.","operationId":"metadataExpression","produces":["application/json"],"parameters":[{"name":"expressionparam","in":"body","description":"Parameters to select metadata","required":true,"schema":{"$ref":"#/definitions/expressionparams"}}],"responses":{"200":{"description":"Expression for selected metadata","type":"object","schema":{"$ref":"#/definitions/payloadExprObj"}},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/ErrorPayload"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/ErrorPayload"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/ErrorPayload"}}}}}},"definitions":{"summaryparams":{"type":"object","required":["infodom","locale","pagination"],"properties":{"infodom":{"type":"string"},"locale":{"type":"string"},"user":{"type":"string"},"code":{"type":"string"},"version":{"type":"string"},"appid":{"type":"string"},"pagination":{"$ref":"#/definitions/pagination"},"sort":{"$ref":"#/definitions/sort"}}},"detailparams":{"type":"object","required":["infodom","locale","code","version","user"],"properties":{"infodom":{"type":"string"},"locale":{"type":"string"},"code":{"type":"string"},"version":{"type":"string"},"user":{"type":"string"}}},"summaryPayload":{"type":"object","properties":{"payload":{"type":"array","items":{"$ref":"#/definitions/payload"}},"pagination":{"$ref":"#/definitions/pagination"},"sort":{"$ref":"#/definitions/sort"}}},"payload":{"type":"object","required":["code","name","desc","infodom","entity","attribute"],"properties":{"code":{"type":"string"},"entity":{"type":"string"},"attribute":{"type":"string"},"version":{"type":"string"},"infodom":{"type":"string"},"authdt":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"error":{"type":"object","required":["errorcode","errormsg"],"properties":{"errorcode":{"type":"string"},"errormsg":{"type":"string"}}},"pagination":{"type":"object","required":["pagenum","pagesize"],"properties":{"pagenum":{"type":"string"},"pagesize":{"type":"string"}}},"sort":{"type":"object","required":["sortby","sortorder"],"properties":{"sortby":{"type":"string"},"sortorder":{"type":"string"}}},"payloadMsrObj":{"type":"object","properties":{"code":{"type":"string"},"shortDescription":{"type":"string"},"longDescription":{"type":"string"},"aggregationFunction":{"type":"string"},"aggregationType":{"type":"string"},"attributeCode":{"type":"string"},"cubeCode":{"type":"string"},"cubeDescription":{"type":"string"},"dataType":{"type":"string"},"decodeString":{"type":"string"},"entityCode":{"type":"string"},"filterClause":{"type":"string"},"filterClauseNew":{"type":"string"},"mappedCubeCode":{"type":"boolean"},"loggedInIP":{"type":"string"},"enabled":{"type":"boolean"},"autoAuthorization":{"type":"boolean"},"comment":{"type":"string"},"strLocale":{"type":"string"},"metadataGuid":{"type":"number"},"isWhitelistingRequired":{"type":"boolean"},"creatorID":{"type":"string"},"dCreationDate":{"type":"string"},"lastModifierID":{"type":"string"},"dLastModifiedDate":{"type":"string"},"authorizerID":{"type":"string"},"dAuthorizationDate":{"type":"string"}}},"expressionparams":{"type":"object","required":["infodom","locale","user","metadata"],"properties":{"infodom":{"type":"string"},"locale":{"type":"string"},"user":{"type":"string"},"metadata":{"type":"array","items":{"$ref":"#/definitions/metadataList"}}}},"metadataList":{"type":"object","required":["type","codes"],"properties":{"type":{"type":"string","description":"Type of the metadata, for eg Measure = 1, Hierarchy = 3, Dataset = 4,  Business Processor =  59"},"codes":{"type":"array","items":{"type":"string"},"description":"Contains the comma separated list of metadata code"}}},"ErrorPayload":{"type":"object","properties":{"error":{"type":"object","schema":{"$ref":"#/definitions/ErrorList"}}}},"ErrorList":{"type":"array","items":{"$ref":"#/definitions/Error"},"description":"Array of Errors"},"Error":{"type":"object","required":["errorcode","errormsg"],"properties":{"errorcode":{"type":"string"},"errormsg":{"type":"string"},"errorparams":{"type":"array","items":{"type":"string"},"description":"Contains the  comma separated erreneous parameters. For instance if the errorcode is INVALID_PARAMS_RECEIVED, then the errorparams will have infodom,locale indicating that these two parameters had invalid input values. Applicable in case of status  400,401,403,413. "}}},"payloadExprObj":{"type":"object","properties":{"payload":{"type":"array","items":{"$ref":"#/definitions/dataList"}},"offload":{"type":"array","items":{"$ref":"#/definitions/dataList"}}}},"dataList":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/definitions/data"}}}},"data":{"type":"object","required":["code","expression"],"properties":{"code":{"type":"string"},"expression":{"type":"string"}}}}}