Jump to

• Request
• Response

Retrieve Value of All Facts for Batches

post

/api/1.0/callActionTransactional/getCollectionFacts

This endpoint is used to retrieve the list of entity fact values.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• acctId(optional): string
  The account ID used to fetch the fact values.

Header Parameters

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

Body ()

Request Body that contains data required for fetching facts values against entities.

Root Schema : DmEntityFactValuesCollection

Type: object

Collection of DmEntityFactValues.

Show Source

• dmEntityFactValuesList(optional): 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(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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : DmEntityFactValuesCollection

Type: object

Collection of DmEntityFactValues.

Show Source

• dmEntityFactValuesList(optional): 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(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

201 Response

Returns message of succes or failure.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): 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(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): 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(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): 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