Update Determining Attributes
Last updated
Last updated
Several types of updates can be performed using this API. You can add more values to the attribute, you can add priorities to the determining attribute, and you can set filters on determining attributes. Note that these are run as ‘PATCH’ for updates, as opposed to ‘POST’ for creation.
Setting Priorities
This example shows using the valuesPriority option to set priorities on previously created attributes.
Here, we use the id for the determining attribute in the entity section to identify it as an existing attribute. This can be found in the response of the Create Determining Attribute API or in the Get DA Details API. We also identify the values of the determining attribute that we want to set priorities for (this DA has only two values). In the valuesPriority section, we list the value and the associated priority.
The API call is the same protocol://server:port as above, but it is defined as ‘PATCH’ instead of ‘POST’ for this process.
{
"context": {
"user": "mbj_test",
"password": "xxxx",
"project": {
"name": "imp_payments_demo",
"version": "1.0"
}
},
"entity": {
"id": "645e0000390613152b16ecbb",
"values": [
"0",
"1"
],
"valuesPriority": {
"0": "1",
"1": "2",
}
}
}
Here is the Postman screen after the API has been run showing that the priorities were set.
And here is the edit determining attributes screen from the TDO UI, showing the priorities assigned to the values.
Group by Settings for Attributes
Group by for determining attributes is a process in TDO that allows you to enforce valid combinations of data – for instance, I can choose to group ‘has_app’ by ‘customer_type’. In this demo database, customers with a customer type of ‘Retail’ can have the value of ‘0’ [false] or ‘1’ [true] for ‘has_app’ but customer type of ‘Corporate’ can only have the value of ‘0’. By adding the group by, I make sure that if I select the ‘Corporate’ customer type, only the ‘false’ option will display for has_app, preventing a user from selecting an invalid option (‘true’) in error.
Group by will only work for fields that are in the same source data block; you cannot group by a field that exists in a different data block as there is not relationship defined for TDO to refer to. The determining attribute is identified by it’s id number. The attribute values are listed. Then in the criteria section, each value has the ‘group by’ attribute identified.
The API is defined the same as for setting priorities. The body is similar, except that the 'group by' field is listed in the criteria section of the body instead of the 'priority'.
{
"context": {
"user": "mbj_test",
"password": "xxxx",
"project": {
"name": "imp_payments_demo",
"version": "1.0"
}
},
"entity": {
"id": "645e0000390613152b16ecbb",
"values": [
"0",
"1"
],
"criteria": {
"0": "customer_type",
"1": "customer_type",
}
}
}
When run, Postman shows the results as below.
In TDO, you can now see the group by results. The column on the right in the bottom section of the screen below (Determining Attribute) is the column that the Data Block Attribute (on the left) is grouped by. Note that since this update was performed on an attribute that already had priorities set, those are also shown in the return message.
