Jump to

• Request
• Response

Retrieve Fact Details by Category

get

/obedm-common-services/factDetails/category/{category}

This endpoint is used to retrieve fact details by category.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• category: string
  Category of the Facts that needs to be fetched.

Header Parameters

• appId: string
  The ID of the Application.
• branchCode: string
  The branch code associated with the request.
• contentType(optional): string
  The Content Type of the request.
• tenantId(optional): string
  The ID of the Tenant.
• userId: string
  The ID of the User.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the list of fact details based on given category.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DmEntityFactValues
  DmEntityFactValues model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmEntityFactValues"
    }
}

Nested Schema : DmEntityFactValues

Type: object

DmEntityFactValues model

Show Source

• entityName(optional): string
  Entity Name
• factName(optional): string
  Fact Name
• fieldName(optional): string
  Column Name
• fieldValue(optional): object fieldValue
  Column Value

{
    "description":"DmEntityFactValues model",
    "type":"object",
    "properties":{
        "entityName":{
            "description":"Entity Name",
            "type":"string"
        },
        "factName":{
            "description":"Fact Name",
            "type":"string"
        },
        "fieldName":{
            "description":"Column Name",
            "type":"string"
        },
        "fieldValue":{
            "description":"Column Value",
            "type":"object"
        }
    }
}

Nested Schema : fieldValue

Type: object

Column Value

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top