SAP Knowledge Base Article - Public

3723445 - DynamicGroupDefinition OData API not returning Workflow Dynamic Groups and Missing People Pool Expression.

Symptom

While trying to fetch the details for Workflow Dynamic Group and people pool expression using DynamicGroupDefinition OData API, not results are being returned. DynamicGroupDefinition OData API only returns the details for Permission Groups. 

Environment

  • SAP SuccessFactors HCM Suite
  • OData API

Cause

Dynamic Group Definition API currently only supports dynamic groups defined in the Manage Permission Groups tool in Admin Center. A dynamic group definition contains information of people pools that are included in and excluded from a Permission Groups. Therefore, when workflow groups are fetched via DynamicGroupDefinition API, no results are being returned.

Resolution

Workaround:

Customers can still get People Pool Expression for workflow dynamic group by using getExpandedDynamicGroupById function import.
It is a GET OData API with URI: https://<api-server>/odata/v2/getExpandedDynamicGroupById?groupId=XXXX.

Example:

URL:
https://<api-server>/odata/v2/getExpandedDynamicGroupById?groupId=2409L

Response:

{
    "d": {
        "__metadata": {
            "uri": "https://<API-Server>/odata/v2/DynamicGroup(2409L)",
            "type": "SFOData.DynamicGroup"
        },
        "groupID": "2409",
        "activeMembershipCount": 1,
        "createdBy": null,
        "groupName": "Organizational Design Expert CA",
        "groupType": "ectworkflow",
        "lastModifiedDate": "/Date(1505907023000)/",
        "staticGroup": false,
        "totalMemberCount": null,
        "userType": null,
        "dgIncludePools": {
            "results": [
                {
                    "__metadata": {
                        "uri": "https://<API-Server>/odata/v2/DGPeoplePool('2409_1')",
                        "type": "SFOData.DGPeoplePool"
                    },
                    "peoplePoolId": "2409_1",
                    "filters": {
                        "results": [
                            {
                                "__metadata": {
                                    "uri": "https://<API-Server>/odata/v2/DGFilter('std_title_2409__1_0')",
                                    "type": "SFOData.DGFilter"
                                },
                                "filterId": "std_title_2409__1_0",
                                "expressions": {
                                    "results": [
                                        {
                                            "__metadata": {
                                                "uri": "https://<API-Server>/odata/v2/DGExpression('std_title_2409__1_0_0')",
                                                "type": "SFOData.DGExpression"
                                            },
                                            "expressionID": "std_title_2409__1_0_0",
                                            "operator": {
                                                "__metadata": {
                                                    "uri": "https://<API-Server>/odata/v2/DGFieldOperator('eq')",
                                                    "type": "SFOData.DGFieldOperator"
                                                },
                                                "token": "eq",
                                                "label": "= (equal to)"
                                            },
                                            "values": {
                                                "results": [
                                                    {
                                                        "__metadata": {
                                                            "uri": "https://<API-Server>/odata/v2/DGFieldValue('MC HR Administrator (Position1516)')",
                                                            "type": "SFOData.DGFieldValue"
                                                        },
                                                        "fieldValue": "MC HR Administrator (Position1516)",
                                                        "externalCode": null
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                },
                                "field": {
                                    "__metadata": {
                                        "uri": "https://<API-Server>/odata/v2/DGField('std_title')",
                                        "type": "SFOData.DGField"
                                    },
                                    "name": "std_title",
                                    "dataType": "String",
                                    "label": "Position",
                                    "picklistId": null,
                                    "allowedOperators": {
                                        "results": [
                                            {
                                                "__metadata": {
                                                    "uri": "https://<API-Server>/odata/v2/DGFieldOperator('eq')",
                                                    "type": "SFOData.DGFieldOperator"
                                                },
                                                "token": "eq",
                                                "label": "= (equal to)"
                                            }
                                        ]
                                    }
                                }
                            },
                            {
                                "__metadata": {
                                    "uri": "https://<API-Server>/odata/v2/DGFilter('std_country_2409__1_1')",
                                    "type": "SFOData.DGFilter"
                                },
                                "filterId": "std_country_2409__1_1",
                                "expressions": {
                                    "results": [
                                        {
                                            "__metadata": {
                                                "uri": "https://<API-Server>/odata/v2/DGExpression('std_country_2409__1_1_0')",
                                                "type": "SFOData.DGExpression"
                                            },
                                            "expressionID": "std_country_2409__1_1_0",
                                            "operator": {
                                                "__metadata": {
                                                    "uri": "https://<API-Server>/odata/v2/DGFieldOperator('eq')",
                                                    "type": "SFOData.DGFieldOperator"
                                                },
                                                "token": "eq",
                                                "label": "= (equal to)"
                                            },
                                            "values": {
                                                "results": [
                                                    {
                                                        "__metadata": {
                                                            "uri": "https://<API-Server>/odata/v2/DGFieldValue('Canada')",
                                                            "type": "SFOData.DGFieldValue"
                                                        },
                                                        "fieldValue": "Canada",
                                                        "externalCode": null
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                },
                                "field": {
                                    "__metadata": {
                                        "uri": "https://<API-Server>/odata/v2/DGField('std_country')",
                                        "type": "SFOData.DGField"
                                    },
                                    "name": "std_country",
                                    "dataType": "String",
                                    "label": "Country",
                                    "picklistId": null,
                                    "allowedOperators": {
                                        "results": [
                                            {
                                                "__metadata": {
                                                    "uri": "https://<API-Server>/odata/v2/DGFieldOperator('eq')",
                                                    "type": "SFOData.DGFieldOperator"
                                                },
                                                "token": "eq",
                                                "label": "= (equal to)"
                                            }
                                        ]
                                    }
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}

Note: The Response payload is just for reference purpose and is from the internal demo system.

See Also

DynamicGroupDefinition | SAP Help Portal

Function Import | SAP Help Portal

Keywords

Dynamic Group Definition, OData API, DynamicGroup,Workflow, Workflow Dynamic Group, getExpandedDynamicGroupById, function, import, get, Permission Group, DynamicGroupDefinition, ect_workflow , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-API , API & Adhoc API Framework , How To

Product

SAP SuccessFactors HCM Core 2505