ListAdherenceAgentStateViolations

POST

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

Lists the adherence agent states using the given parameters for the org sending the request.
Accepts filtering by either @wfm_agent_sids, @datetime_range, or both. At least one of the two fields must be set.
If @wfm_agent_sids is nil, violations will be returned for all agents after @start_datetime.
If @wfm_agent_sids is set, violations will only be returned for those agents.
If @datetime_range is nil, violations starting at any point in time for @wfm_agent_sids will be returned.
If @datetime_range is set, any violations that start within @datetime_range will be included.
If @include_resolved is true, resolved and unresolved violations will be returned. Otherwise only unresolved violations will be included in the response.
Errors:

grpc.Invalid: arguments in the request are invalid.

grpc.Internal: error occurs when getting the violations.

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/listadherenceagentstateviolations' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

ListAdherenceAgentStates

ResolveAdherenceAgentStateViolation