getAllEntitySpecUsesByEntityId
- Description
- This inquiry transaction retrieves a list of all entity spec uses that the given entity instance is associated with. An entity spec use defines an association between an entity instance (such as category, product type, or agreement type) and a spec.
- Web Services
- Operation name: getAllEntitySpecUsesByEntityId
- Example
- Retrieve all entity spec uses that are
associated with a loan product type instance.
Retrieve all entity spec uses associated with a category.
Retrieve all entity spec uses associated with an agreement type.
- Usage information
- This transaction supports the following entity names:
- PRODUCTTYPE
- CATEGORY
- CDAGREEMENTTP
The EntityName value is not case sensitive and can be provided in lower, upper, or mixed case.
This transaction does not support the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- EntityName
- InstancePK
- Inquiry levels
- Not applicable
- Filter values
- This transaction supports filters. Valid values are:
- ACTIVE – returns only active entity spec use records that the given entity instance is associated with.
- INACTIVE – returns only inactive entity spec use records that the given entity instance is associated with.
- ALL – returns all entity spec use records, both active and inactive, that the given entity instance is associated with.
This filter is optional. Filter values are not case sensitive for this transaction.
If the filter value is not provided, all records are returned by default.
- Transaction behavior
- If the EntityName is PRODUCTTYPE or CATEGORY, the entity
spec uses returned are those that are explicitly defined for
the product type or category instance provided in the request.
To retrieve entity spec uses that are cascaded from a parent product type or ancestor category node, see to the getAllEntitySpecUses transaction.
- Request message
- <InquiryType> GetAllEntitySpecUsesByEntityId
<InquiryParam>
<methodParam name = "InstancePK">
<methodParam name = "EntityName">
<methodParam name = "Filter">
- Response objects
- EntitySpecUseBObj
- Special note
For information about the getAllEntitySpecUsesByProduct transaction, refer to the corresponding reference topic.