ListCandidateSchedulingActivities

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/listcandidateschedulingactivities

Lists the candidate scheduling activities for a constraint or placement rule, inherited through given @parent_of_rule for @schedule_scenario_sid for the org making the request.
@parent_of_rule may be any type of node, agent group, or shift template which the rule will belong to.
If the rule will belong to a wfm agent, the agent group must be supplied instead to get a relevant set of candidate scheduling activities.
Member non skill activity of each scheduling activity will be included in the response.
The on call scheduling activity will always be included.
Reason codes will be included with the returned scheduling activities.
Errors:

grpc.Invalid: the @parent_of_rule is invalid.

grpc.NotFound: @parent_of_rule doesn't exist

grpc.Internal: error occurs when applying inheritance or getting the nodes from @parent_of_rule.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/listcandidateschedulingactivities' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

ListNonSkillActivityAssociations

ListSchedulingActivities