ListConfigEntities

Gets config entities that match the org sending the request and given @entity_type and that belong to the @belongs_to_entity and @schedule_scenario_sid parameters.
If @include_member_lists is set to true the member lists of the entities retrieved will be included.
Any nodes in the returned set of entities will have inherited nonskill associations applied to the node's member_nonskill_activity fields.
Errors:

grpc.Invalid: the @entity_type, or @belongs_to_entity have invalid values.

grpc.Internal: error occurs when getting the config entities.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "entity_type": "CALL_CENTER_NODE",
    "belongs_to_entity": {
        "parent_sid": 0,
        "parent_type": "CALL_CENTER_NODE"
    },
    "include_inactive": true,
    "member_depth": 0,
    "schedule_scenario_sid": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "agent_availability_patterns": {
        "entities": [
            {
                "agent_availability_pattern_sid": 0,
                "parent_entity": {
                    "parent_sid": 0,
                    "parent_type": "CALL_CENTER_NODE"
                },
                "datetime_pattern": {
                    "week_maps": [
                        {
                            "datetime_range": {
                                "start_datetime": "1s",
                                "end_datetime": "1s"
                            },
                            "day_maps": [
                                {
                                    "day_of_week": "MON",
                                    "start_minute_in_day": 0,
                                    "end_minute_in_day": 0,
                                    "value": {
                                        "availability_option": "AVAILABLE"
                                    }
                                }
                            ]
                        }
                    ],
                    "calendar_items": [
                        {
                            "datetime_range": {
                                "start_datetime": "1s",
                                "end_datetime": "1s"
                            },
                            "value": {
                                "availability_option": "AVAILABLE"
                            }
                        }
                    ]
                },
                "schedule_scenario_sid": 0,
                "scheduling_activity_sid": "string"
            }
        ]
    }
}

🟢200Success