{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"paths":{"/refdata/commondata/lov/categories/{categoryId}":{"get":{"tags":["crd-api-controller"],"summary":"CommonData API will be used to retrieve the list of category values for a given category id.","description":"Any valid IDAM role should be able to access this API ","operationId":"retrieveListOfValuesByCategoryId","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"parentCategory","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"parentKey","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"key","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"isChildRequired","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"externalReferenceType","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"externalReference","in":"query","description":"Any Valid String is allowed","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Authorization token","required":true,"schema":{"type":"string"}},{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved list of Category Values for the request provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Categories"}}}},"400":{"description":"Bad Request"},"401":{"description":"Forbidden Error: Access denied"},"500":{"description":"Internal Server Error"}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/refdata/commondata/caseflags/service-id={service-id}":{"get":{"tags":["case-flag-api-controller"],"summary":"CommonData API will be used to retrieve the list of case flags for a given service id.","description":"Any valid IDAM role should be able to access this API ","operationId":"retrieveCaseFlagsByServiceId","parameters":[{"name":"service-id","in":"path","description":"Any Valid String is allowed","required":true,"schema":{"type":"string"}},{"name":"flag-type","in":"query","description":"Allowed Values are PARTY or CASE","required":false,"schema":{"type":"string"}},{"name":"welsh-required","in":"query","description":"Allowed Values are Y or N","required":false,"schema":{"type":"string"}},{"name":"available-external-flag","in":"query","description":"Allowed Values are Y or N","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Authorization token","required":true,"schema":{"type":"string"}},{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved list of Case Flag for the request provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseFlag"}}}},"400":{"description":"Bad Request"},"401":{"description":"Forbidden Error: Access denied"},"500":{"description":"Internal Server Error"}},"security":[{"Authorization":[]},{"ServiceAuthorization":[]}]}},"/":{"get":{"tags":["root-controller"],"summary":"Welcome","operationId":"welcome","parameters":[{"name":"Authorization","in":"header","description":"Authorization token","required":true,"schema":{"type":"string"}},{"name":"ServiceAuthorization","in":"header","description":"Keyword `Bearer` followed by a service-to-service token for a whitelisted micro-service","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Welcome message","content":{"application/json":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"Categories":{"type":"object","properties":{"list_of_values":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"Category":{"type":"object","properties":{"category_key":{"type":"string"},"key":{"type":"string"},"value_en":{"type":"string"},"value_cy":{"type":"string"},"hint_text_en":{"type":"string"},"hint_text_cy":{"type":"string"},"lov_order":{"type":"integer","format":"int64"},"parent_category":{"type":"string"},"parent_key":{"type":"string"},"active_flag":{"type":"string"},"external_reference_type":{"type":"string"},"external_reference":{"type":"string"},"child_nodes":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"CaseFlag":{"type":"object","properties":{"flags":{"type":"array","items":{"$ref":"#/components/schemas/Flag"}}}},"Flag":{"type":"object","properties":{"FlagDetails":{"type":"array","items":{"$ref":"#/components/schemas/FlagDetail"}}}},"FlagDetail":{"type":"object","properties":{"name":{"type":"string"},"hearingRelevant":{"type":"boolean"},"flagComment":{"type":"boolean"},"defaultStatus":{"type":"string"},"externallyAvailable":{"type":"boolean"},"flagCode":{"type":"string"},"nativeFlagCode":{"type":"string"},"childFlags":{"type":"array","items":{"$ref":"#/components/schemas/FlagDetail"}},"listOfValuesLength":{"type":"integer","format":"int32"},"listOfValues":{"type":"array","items":{"$ref":"#/components/schemas/ListOfValue"}},"name_cy":{"type":"string"},"isParent":{"type":"boolean"},"Path":{"type":"array","items":{"type":"string"}}}},"ListOfValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"value_cy":{"type":"string"}}}},"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"ServiceAuthorization":{"type":"apiKey","description":"ServiceAuthorization","name":"ServiceAuthorization","in":"header","bearerFormat":"JWT"}}}}