Quick referencesChanges to List APIs - Deprecation of Aggregation Data
Introduction
We're implementing changes to our List APIs regarding the usage of aggregation data. This update aims to ensure a seamless transition for our valued users.
Change details
Currently, customers have been utilizing List APIs with aggregation data. To accommodate this, we've recently introduced new dedicated APIs containing only aggregation data. This way, users have the option to use the new APIs if needed.
Upcoming change
We'll deprecate the aggregation data from the original List APIs after two weeks.
Impact
As a result of this change, the aggregation data will no longer be available through the original List APIs. Users are encouraged to transition to the new dedicated APIs for aggregation data.
We appreciate your understanding during this transition. If you have any questions or require assistance, please contact our support team.
Scheduled date:
Weβve tentatively planned these changes for the second week of November 2023.
New Aggregation API details
1. Name: get-my-task-aggregation
Endpoint: process/2/<account_id>/<process_id>/myitems/<status>/aggregation
Params:
page_number: <number>
page_size: <number>
Response:
{
"Name": {
"Count": 10,
"Blank": 0,
"NonBlank": 10
},
"_created_at": {
"Min": "2023-01-11T12:30:25Z",
"Max": "2023-02-02T17:33:52Z",
"Count": 10,
"Blank": 0,
"NonBlank": 10
},
"_progress": {
"Sum": 0,
"Min": 0,
"Max": 0,
"Average": 0,
"Count": 10,
"Blank": 0,
"NonBlank": 10
}
}
2. Name: get-pending-task-aggregation
Endpoint: process/2/<account_id>/<process_id>/pending/<status>/aggregation
Params:
page_number: <number>
page_size: <number>
Response:
{
"Name": {
"Count": 10,
"Blank": 0,
"NonBlank": 10
},
"_created_at": {
"Min": "2023-01-11T12:30:25Z",
"Max": "2023-02-02T17:33:52Z",
"Count": 10,
"Blank": 0,
"NonBlank": 10
},
"_progress": {
"Sum": 0,
"Min": 0,
"Max": 0,
"Average": 0,
"Count": 10,
"Blank": 0,
"NonBlank": 10
}
}
Name: get-aggregation
Endpoint: /process/2/<account_id>/admin/<process_id>/item/aggregation
Params:
page_number: <number>
page_size: <number>
Response:
{
"Name": {
"Count": 10,
"Blank": 0,
"NonBlank": 10
},
"_created_at": {
"Min": "2023-01-11T12:30:25Z",
"Max": "2023-02-02T17:33:52Z",
"Count": 10,
"Blank": 0,
"NonBlank": 10
},
"_progress": {
"Sum": 0,
"Min": 0,
"Max": 0,
"Average": 0,
"Count": 10,
"Blank": 0,
"NonBlank": 10
}
}
Old API details
1. Name: get-my-tasks
Endpoint: process/2/<account_id>/<process_id>/myitems/<status>
Params:
page_number: <number>
page_size: <number>
Old response |
New response |
{ "_id": "MD5", "Columns": [ { "Id": "Name", "ReadOnly": true, "Name": "Name", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_at", "ReadOnly": true, "Name": "Created at", "Type": "DateTime", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_current_step", "ReadOnly": true, "Name": "Current step", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_progress", "ReadOnly": true, "Name": "Progress", "Type": "Number", "IsSystemField": true, "Model": "MD5", "Widget": "Progress", "Required": false, "IsInternal": false, "Decimalpoint": null }, { "Id": "Untitled_Field", "ReadOnly": true, "Name": "Text", "Type": "Text", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Users", "ReadOnly": true, "Name": "User", "Type": "User", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "SourceFlowId": "User", "SourceFlowType": "User" }, { "Id": "Select_1", "ReadOnly": false, "Name": "Select", "Type": "Multiselect", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Multi_select", "ReadOnly": false, "Name": "Multi select", "Type": "Multiselect", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Multi_User_Field", "ReadOnly": false, "Name": "Multi User Field", "Type": "MultiUser", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "user_name", "ReadOnly": false, "Name": "user name", "Type": "Text", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false } ], "Sort": [], "Filter": {}, "Data": [ { "Name": "MD5 from KF User", "_current_step": "Step 1", "_created_at": "2023-09-06T09:35:04Z", "_progress": 0, "Untitled_Field": "MD5 from KF User", "Users": { "_id": "Us67awJyA944", "Name": "KF User", "Kind": "User" }, "Select_1": [ "Pine Apple" ], "Multi_select": [ "list data 1", "list data 2", "list data 3", "list data 4" ], "user_name": "kissflow", "_id": "Pk7moKWbR7ux", "_activity_id": "Activity_P4_56Z_D0m", "_activity_instance_id": "Pk7moKXXHIK8" } ], "Aggregation": { "Name": { "Count": 10, "Blank": 1, "NonBlank": 9 }, "_created_at": { "Min": "2023-07-26T11:10:55Z", "Max": "2023-09-06T09:35:04Z", "Count": 10, "Blank": 0, "NonBlank": 10 }, "_current_step": { "Count": 10, "Blank": 0, "NonBlank": 10 }, "_progress": { "Sum": 0, "Min": 0, "Max": 0, "Average": 0, "Count": 10, "Blank": 0, "NonBlank": 10 }, "Untitled_Field": { "Count": 10, "Blank": 5, "NonBlank": 5 }, "Users": { "Count": 10, "Blank": 0, "NonBlank": 10 }, "Select_1": { "Count": 10, "Blank": 0, "NonBlank": 10 }, "Multi_select": { "Count": 10, "Blank": 0, "NonBlank": 10 }, "Multi_User_Field": { "Count": 10, "Blank": 10, "NonBlank": 0 }, "user_name": { "Count": 10, "Blank": 0, "NonBlank": 10 } } } |
{ "_id": "MD5", "Columns": [ { "Id": "Name", "ReadOnly": true, "Name": "Name", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_at", "ReadOnly": true, "Name": "Created at", "Type": "DateTime", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_current_step", "ReadOnly": true, "Name": "Current step", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_progress", "ReadOnly": true, "Name": "Progress", "Type": "Number", "IsSystemField": true, "Model": "MD5", "Widget": "Progress", "Required": false, "IsInternal": false, "Decimalpoint": null }, { "Id": "Untitled_Field", "ReadOnly": true, "Name": "Text", "Type": "Text", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Users", "ReadOnly": true, "Name": "User", "Type": "User", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "SourceFlowId": "User", "SourceFlowType": "User" }, { "Id": "Select_1", "ReadOnly": false, "Name": "Select", "Type": "Multiselect", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Multi_select", "ReadOnly": false, "Name": "Multi select", "Type": "Multiselect", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Multi_User_Field", "ReadOnly": false, "Name": "Multi User Field", "Type": "MultiUser", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "user_name", "ReadOnly": false, "Name": "user name", "Type": "Text", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false } ], "Sort": [], "Filter": {}, "Data": [ { "Name": "MD5 from KF User", "_current_step": "Step 1", "_created_at": "2023-09-06T09:35:04Z", "_progress": 0, "Untitled_Field": "MD5 from KF User", "Users": { "_id": "Us67awJyA944", "Name": "KF User", "Kind": "User" }, "Select_1": [ "Pine Apple" ], "Multi_select": [ "list data 1", "list data 2", "list data 3", "list data 4" ], "user_name": "kissflow", "_id": "Pk7moKWbR7ux", "_activity_id": "Activity_P4_56Z_D0m", "_activity_instance_id": "Pk7moKXXHIK8" } ], } |
2. Name: get-pending-activity-task
Endpoint: process/2/<account_id>/<process_id>/pending/<status>
Params:
page_number: <number>
page_size: <number>
Old response |
New response |
{ "_id": "MD5", "Columns": [ { "Id": "Name", "ReadOnly": true, "Name": "Name", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_at", "ReadOnly": true, "Name": "Created at", "Type": "DateTime", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_by", "ReadOnly": true, "Name": "Created by", "Type": "User", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "SourceFlowId": "User", "SourceFlowType": "User" } ], "Sort": [], "Filter": {}, "Data": [ { "Name": "MD5 from KF User", "_created_at": "2023-08-17T08:59:57Z", "_created_by": { "_id": "Us6885pe4BZ8", "Name": "KF User", "Kind": "User" }, "_id": "Pk7fVl3SHrSA", "_activity_id": "Activity_mTxTXYvRG", "_activity_instance_id": "Pk7fVlO7XndK" }, { "Name": "MD5 from KF User", "_created_at": "2023-08-01T02:36:11Z", "_created_by": { "_id": "Us6885pe4BZ8", "Name": "KF User", "Kind": "User" }, "_id": "Pk7_ZcljpOsp", "_activity_id": "Activity_mTxTXYvRG", "_activity_instance_id": "Pk7_ZcrCctvn" } ], "PageSize": null, "Aggregation": { "Name": { "Count": 10, "Blank": 2, "NonBlank": 8 }, "_created_at": { "Min": "2023-07-26T10:55:32Z", "Max": "2023-08-17T08:59:57Z", "Count": 10, "Blank": 0, "NonBlank": 10 }, "_created_by": { "Count": 10, "Blank": 0, "NonBlank": 10 } } } |
{ "_id": "MD5", "Columns": [ { "Id": "Name", "ReadOnly": true, "Name": "Name", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_at", "ReadOnly": true, "Name": "Created at", "Type": "DateTime", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_by", "ReadOnly": true, "Name": "Created by", "Type": "User", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "SourceFlowId": "User", "SourceFlowType": "User" } ], "Sort": [], "Filter": {}, "Data": [ { "Name": "MD5 from KF User", "_created_at": "2023-08-17T08:59:57Z", "_created_by": { "_id": "Us6885pe4BZ8", "Name": "KF User", "Kind": "User" }, "_id": "Pk7fVl3SHrSA", "_activity_id": "Activity_mTxTXYvRG", "_activity_instance_id": "Pk7fVlO7XndK" }, { "Name": "MD5 from KF User", "_created_at": "2023-08-01T02:36:11Z", "_created_by": { "_id": "Us6885pe4BZ8", "Name": "KF User", "Kind": "User" }, "_id": "Pk7_ZcljpOsp", "_activity_id": "Activity_mTxTXYvRG", "_activity_instance_id": "Pk7_ZcrCctvn" } ], "PageSize": null, } |
3. Name: get-items
Endpoint: /process/2/<account_id>/admin/<process_id>/item
Params:
page_number: <number>
page_size: <number>
Old response |
New response |
{ "_id": "MD5", "Columns": [ { "Id": "Name", "ReadOnly": true, "Name": "Name", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_at", "ReadOnly": true, "Name": "Created at", "Type": "DateTime", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_by", "ReadOnly": true, "Name": "Created by", "Type": "User", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "SourceFlowId": "User", "SourceFlowType": "User" }, { "Id": "_status", "ReadOnly": true, "Name": "Status", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": "Status", "Required": false, "IsInternal": false }, { "Id": "Untitled_Field", "ReadOnly": "False", "Name": "Untitled field", "Type": "Text", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Lookup", "ReadOnly": "False", "Name": "Lookup", "Type": "Reference", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "Attributes": [ { "Id": "Name", "Name": "Name", "Type": "Text" }, { "Id": "Name_1", "Name": "Name", "Type": "Text" } ] }, { "Id": "bool", "ReadOnly": "False", "Name": "bool", "Type": "Boolean", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false } ], "Sort": [], "Filter": {}, "Data": [ { "_created_by": { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" }, "Name": "MD5 from KF user", "_created_at": "2023-10-11T12:24:27Z", "_status": "InProgress", "Lookup": {}, "bool": true, "_id": "Pk7zd2C_rRqc", "_activity_instance_id": [ "Pk7zdKAemEoK" ], "_current_assigned_to": [ { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" } ] }, { "_created_by": { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" }, "Name": "MD5 from KF User", "_created_at": "2023-09-29T06:41:05Z", "_status": "InProgress", "Untitled_Field": "bndnfbdn", "Lookup": {}, "_id": "Pk7vAYamt9Jg", "_activity_instance_id": [ "Pk7vAYfNy_uQ" ], "_current_assigned_to": [ { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" } ] } ], "Aggregation": { "Name": { "Count": 10, "Blank": 1, "NonBlank": 9 }, "_created_at": { "Min": "2023-07-26T11:10:55Z", "Max": "2023-09-06T09:35:04Z", "Count": 10, "Blank": 0, "NonBlank": 10 }, "_progress": { "Sum": 0, "Min": 0, "Max": 0, "Average": 0, "Count": 10, "Blank": 0, "NonBlank": 10 }, "_status": { "Count": 10, "Blank": 5, "NonBlank": 5 }, "_created_by": { "Count": 10, "Blank": 0, "NonBlank": 10 }, "bool": { "Count": 10, "Blank": 0, "NonBlank": 10 }, "Lookup": { "Count": 10, "Blank": 0, "NonBlank": 10 } } } |
{ "_id": "MD5", "Columns": [ { "Id": "Name", "ReadOnly": true, "Name": "Name", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_at", "ReadOnly": true, "Name": "Created at", "Type": "DateTime", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "_created_by", "ReadOnly": true, "Name": "Created by", "Type": "User", "IsSystemField": true, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "SourceFlowId": "User", "SourceFlowType": "User" }, { "Id": "_status", "ReadOnly": true, "Name": "Status", "Type": "Text", "IsSystemField": true, "Model": "MD5", "Widget": "Status", "Required": false, "IsInternal": false }, { "Id": "Untitled_Field", "ReadOnly": "False", "Name": "Untitled field", "Type": "Text", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false }, { "Id": "Lookup", "ReadOnly": "False", "Name": "Lookup", "Type": "Reference", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false, "Attributes": [ { "Id": "Name", "Name": "Name", "Type": "Text" }, { "Id": "Name_1", "Name": "Name", "Type": "Text" } ] }, { "Id": "bool", "ReadOnly": "False", "Name": "bool", "Type": "Boolean", "IsSystemField": false, "Model": "MD5", "Widget": null, "Required": false, "IsInternal": false } ], "Sort": [], "Filter": {}, "Data": [ { "_created_by": { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" }, "Name": "MD5 from KF user", "_created_at": "2023-10-11T12:24:27Z", "_status": "InProgress", "Lookup": {}, "bool": true, "_id": "Pk7zd2C_rRqc", "_activity_instance_id": [ "Pk7zdKAemEoK" ], "_current_assigned_to": [ { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" } ] }, { "_created_by": { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" }, "Name": "MD5 from KF User", "_created_at": "2023-09-29T06:41:05Z", "_status": "InProgress", "Untitled_Field": "bndnfbdn", "Lookup": {}, "_id": "Pk7vAYamt9Jg", "_activity_instance_id": [ "Pk7vAYfNy_uQ" ], "_current_assigned_to": [ { "_id": "Us7ulPE2YMTQ", "Name": "KF User", "Kind": "User" } ] } ], } |