Jump to

• Request
• Response

Retrieve the list of all fact values associated with entities

post

/dmaccount-service/dmaccountgetfacts

This endpoint is used to retrieve the list of all the fact values associated with entities.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• acctId: string
  Account ID for which details to be fetched.

Header Parameters

• appId(required): string
  The application ID of the host service.
• branchCode(required): string
  The branch code of the requesting branch.
• contentType: string
  The content type of the request or response body.
• userId(required): string
  The userid of the requesting user.

Body ()

Request body that contains data required for fetching fact values associated with entities.

Root Schema : DmEntityFactValuesCollection

Type: object

Collection of DmEntityFactValues.

Show Source

• dmEntityFactValuesList: array dmEntityFactValuesList

{
    "description":"Collection of DmEntityFactValues.",
    "type":"object",
    "properties":{
        "dmEntityFactValuesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmEntityFactValues"
            }
        }
    }
}

Nested Schema : dmEntityFactValuesList

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: string
  Entity Name
• factName: string
  Fact Name
• fieldName: string
  Column Name
• fieldValue: 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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the list of fact values.

Body ()

Root Schema : DmEntityFactValuesCollection

Type: object

Collection of DmEntityFactValues.

Show Source

• dmEntityFactValuesList: array dmEntityFactValuesList

{
    "description":"Collection of DmEntityFactValues.",
    "type":"object",
    "properties":{
        "dmEntityFactValuesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmEntityFactValues"
            }
        }
    }
}

Nested Schema : dmEntityFactValuesList

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: string
  Entity Name
• factName: string
  Fact Name
• fieldName: string
  Column Name
• fieldValue: 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

201 Response

Returns a message indicating either success or failure.

Headers

• Location: string
  List of fact values.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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