{"swagger":"2.0","info":{"version":"9.0.0.0.0","title":"AAI REST API Documentation for Model Upload","description":"This document provides details about REST APIs available for Entities","contact":{"name":"AAI Development team"}},"host":"ofss220670:9484","basePath":"/adb/rest-api","schemes":["http"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/entity/summary":{"post":{"description":"Returns summary of entities present in an infodom based on search parameters. The table name or \"code\" is an optional parameter.","operationId":"entitySummary","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"servicesparam","in":"body","description":"Parameters to filter Summary","required":true,"schema":{"$ref":"#/definitions/SummaryServiceParams"}}],"responses":{"200":{"description":"summary response","schema":{"type":"array","items":{"$ref":"#/definitions/SummaryPayload"}}},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/Error"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/Error"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/Error"}}}}},"/entity/detail":{"post":{"description":"Returns details of an Entity available in an infodom","operationId":"entityDetail","produces":["application/json"],"parameters":[{"name":"detailparam","in":"body","description":"Parameters to select Entity Details.","required":true,"schema":{"$ref":"#/definitions/DetailServiceParams"}}],"responses":{"200":{"description":"Detailed Object for Entity","schema":{"type":"array","items":{"$ref":"#/definitions/DetailPayload"}}},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/Error"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/Error"}},"404":{"description":"Not found, Unable to find object in the infodom","schema":{"$ref":"#/definitions/Error"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/Error"}}}}},"/entity/udplist":{"post":{"description":"Returns user defined properties of an Entity available in an infodom","operationId":"entityUDPlist","produces":["application/json"],"parameters":[{"name":"detailparam","in":"body","description":"Parameters to select Entity Details.","required":true,"schema":{"$ref":"#/definitions/UDPServiceParams"}}],"responses":{"200":{"description":"Detailed Object for Entity","schema":{"type":"array","items":{"$ref":"#/definitions/UDPPayload"}}},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/Error"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/Error"}},"404":{"description":"Not found, Unable to find object in the infodom","schema":{"$ref":"#/definitions/Error"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/Error"}}}}},"/entity/primarykey":{"post":{"description":"Returns primary key details of an Entity available in an infodom","operationId":"entityPrimaryKey","produces":["application/json"],"parameters":[{"name":"detailparam","in":"body","description":"Parameters to select Entity Details.","required":true,"schema":{"$ref":"#/definitions/KeyServiceParams"}}],"responses":{"200":{"description":"Detailed Object for Entity","schema":{"type":"array","items":{"$ref":"#/definitions/PKPayload"}}},"400":{"description":"Bad request, functional validations failure","schema":{"$ref":"#/definitions/Error"}},"403":{"description":"Forbidden request, ESAPI validation/Security failure","schema":{"$ref":"#/definitions/Error"}},"404":{"description":"Not found, Unable to find object in the infodom","schema":{"$ref":"#/definitions/Error"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/Error"}}}}}},"definitions":{"SummaryServiceParams":{"type":"object","required":["infodom","pagination"],"properties":{"infodom":{"type":"string"},"code":{"type":"string"},"pagination":{"$ref":"#/definitions/Pagination"}}},"DetailServiceParams":{"type":"object","required":["infodom","code"],"properties":{"infodom":{"type":"string"},"code":{"type":"string"}}},"UDPServiceParams":{"type":"object","required":["infodom"],"properties":{"infodom":{"type":"string"}}},"KeyServiceParams":{"type":"object","required":["infodom","codes"],"properties":{"infodom":{"type":"string"},"codes":{"type":"array","items":{"$ref":"#/definitions/TableNames"}}}},"SummaryPayload":{"type":"object","required":["code","name","desc"],"properties":{"language":{"type":"string"},"code":{"type":"string","format":"int64"},"desc":{"type":"string"},"name":{"type":"string"}}},"DetailPayload":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"owner":{"type":"string"},"version":{"type":"string"},"desc":{"type":"string"},"displayname":{"type":"string"},"col":{"type":"array","items":{"$ref":"#/definitions/DetailedColumns"}},"pk":{"type":"array","items":{"$ref":"#/definitions/PKPayload"}},"fk":{"type":"array","items":{"$ref":"#/definitions/FKPayload"}},"index":{"type":"array","items":{"$ref":"#/definitions/IndexPayload"}}}},"UDPPayload":{"type":"object","required":["language","code","desc","name"],"properties":{"language":{"type":"string"},"code":{"type":"string","format":"int64"},"desc":{"type":"string"},"name":{"type":"string"}}},"PKPayload":{"type":"object","required":["tablename"],"properties":{"tablename":{"type":"string"},"name":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/definitions/Columns"}}}},"FKPayload":{"type":"object","required":["reftable"],"properties":{"reftable":{"type":"string"},"name":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/definitions/ColumnsFK"}}}},"IndexPayload":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/definitions/Columns"}}}},"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"},"sortby":{"type":"string"},"sortorder":{"type":"string"},"totalrec":{"type":"string"}}},"TableNames":{"type":"object"},"Columns":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"sequence":{"type":"string"}}},"ColumnsFK":{"type":"object","required":["basecol"],"properties":{"basecol":{"type":"string"},"sequence":{"type":"string"},"column":{"type":"string"}}},"DetailedColumns":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"logicaltype":{"type":"string"},"size":{"type":"string"},"precision":{"type":"string"},"scale":{"type":"string"},"inherited":{"type":"string"},"displayname":{"type":"string"},"desc":{"type":"string"},"nullable":{"type":"string"}}}}}