LabelConfigModel
keystringrequired
Unique key for the label
Example:process
valuestringrequired
Value associated with the label
Example:LOAN PAYMENT
displayValuestringrequired
Display value of the label
Example:ONE-TIME LOAN PAYMENT
Add label config
Creates mappings for display values of labels
post
Body
application/json
Body
application/json
Response
application/json
Response
application/json
reference data for provided keys retrieved
LabelConfigModel
keystringrequired
Unique key for the label
Example:process
valuestringrequired
Value associated with the label
Example:LOAN PAYMENT
displayValuestringrequired
Display value of the label
Example:ONE-TIME LOAN PAYMENT
post/case/v1/refdata/labelconfigs
Authentication
Body
{
"key": "process",
"value": "LOAN PAYMENT",
"displayValue": "ONE-TIME LOAN PAYMENT"
}
application/json
Get all label config
get all mappings for display values of labels
get
Response
application/json
Response
application/json
reference data for provided keys retrieved
LabelConfigResponse
labelconfigsarray[object]
Show Child Parameters
get/case/v1/refdata/labelconfigs
Authentication
application/json
Search label config
Search mappings for display values of labels
get
Query Parameters
keystringrequired
Label config key
valuestring
Label config value
Response
application/json
Response
application/json
reference data for provided keys retrieved
LabelConfigResponse
labelconfigsarray[object]
Show Child Parameters
get/case/v1/refdata/labelconfigs/search
Authentication
Query Parameters
application/json
Retrieve Reference Data Hierarchy
Retrieves a hierarchical structure of reference data based on the specified type as parent.
get
Path Parameters
refTypestringrequired
The starting parent type in the hierarchy.
Example:DOCUMENT_CATEGORY
Response
application/json
Response
application/json
Retrieved Document hierarchical reference data.
ReferenceResponseTree
typestring
The type of the reference data node.
keystring
The key of the reference data node.
valuestring
The value associated with the reference data node.
childarray[object]
List of child nodes in the reference data hierarchy.
Show Child Parameters
get/case/v1/refdata/{refType}/tree
Authentication
Path Parameters
application/json
Fetch List of reference data by Type and Parent Key
Fetch List of reference data by Type and Parent Key
get
Query Parameters
parentKeystring
The key of the parent entity whose Reference Data are to be retrieved.
Path Parameters
typestringrequired
The type of reference data to retrieve.
Response
application/json
Response
application/json
A list of reference data models.
ReferenceResponseModel
typestring
The type of the reference data.
parentKeystring
The key of the parent entity.
keystring
The key of the reference data.
valuestring
The value associated with the reference data.
get/case/v1/refdata/{type}
Authentication
Path Parameters
Query Parameters
application/json