BuildGlobalDiagnostics

Builds and returns the global diagnostics and @nodes_checked for the @schedule_scenario_sid and the org sending the request.
Errors:

grpc.Invalid: the @schedule_scenario_sid has an invalid values.

grpc.NotFound: the given @schedule_scenario_sid doesn't exist for the org making the request.

grpc.Internal: error occurs when building the diagnostics.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request message for the BuildGlobalDiagnostics RPC

schedule_scenario_sid

integer <int64> | string

schedule_scenario_sid

optional

ID of the schedule scenario to get diagnostics for.

Example

{
    "schedule_scenario_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the BuildGlobalDiagnostics RPC

diagnostics

array[object (Diagnostic) {4}]

diagnostics

optional

Set of diagnostic reports for the given @schedule_scenario_sid.

level

enum<string>

level

optional

The diagnostic level describes the class of the diagnostic message.

Allowed values:

INFORMATIONSUGGESTIONWARNINGDIAGNOSTIC_ERRORINTERNAL_ERROR

code

enum<string>

code

optional

A code to describe the diagnostic when possible. Default value of General when a more specific code is not available.

Allowed values:

GENERALOKNO_SKILLS_IN_DICTIONARYAGENT_HAS_NO_SKILL_PROFICIENCIESAGENT_HAS_NO_SKILLSNO_SCHEDULING_ACTIVITIES_FOR_CONSTRAINT_RULESSCHEDULING_ACTIVITY_FOR_CONSTRAINT_RULE_NOT_FOUNDSHIFT_TEMPLATE_CANNOT_BE_NONESHIFT_TEMPLATE_HAS_NO_PLACEMENT_RULESNO_ONCALL_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_DURATION_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_AGENTS_IN_SHIFT_TEMPLATENO_PLACEMENT_RULES_FOR_SHIFT_TEMPLATEACTIVITIES_SHORTER_THAN_SHIFTNOT_ENOUGH_AGENTS_FOR_SHIFTPROGRAM_HAS_NO_AGENT_GROUPSPROGRAM_HAS_NO_SHIFT_TEMPLATESLOCATION_HAS_NO_PROGRAMSCLIENT_HAS_NO_LOCATIONSCALL_CENTER_HAS_NO_CLIENTSPROGRAM_HAS_INVALID_PARENT_LOCATIONLOCATION_HAS_INVALID_PARENT_CLIENTCLIENT_HAS_INVALID_PARENT_CALL_CENTERAGENT_GROUP_HAS_INVALID_PARENT_NODESHIFT_TEMPLATE_HAS_INVALID_PARENT_PROGRAMNO_SKILL_PROFICIENCY_FOR_MIN_SKILL_PROFICIENCY_CONSTRAINT_RULETOO_MANY_AGENTS_WITH_LOCKED_SHIFTS_FOR_MIN_AGENTSAGENT_DOES_NOT_BELONG_TO_AN_AGENT_GROUPINVALID_CONSTRAINT_VAL_UNITSCONSTRAINT_GENERAL_FAILURECANDIDATE_SHIFT_COLLISION_DETECTEDCANDIDATE_SHIFT_AGENT_NOT_AVAILABLECANDIDATE_CLOSEDCONSTRAINT_ACTIVITY_NOT_FOUNDCONSTRAINT_AGENT_DOES_NOT_HAVE_PROFICIENCYCONSTRAINT_AGENT_PROFICIENCY_TOO_LOWCONSTRAINT_MAX_TOTAL_ON_FAILURECONSTRAINT_MIN_TOTAL_ON_FAILURECONSTRAINT_MAX_TOTAL_OFF_FAILURECONSTRAINT_MIN_TOTAL_OFF_FAILURECONSTRAINT_MAX_CONSEC_ON_FAILURECONSTRAINT_MIN_CONSEC_ON_FAILURECONSTRAINT_MAX_CONSEC_OFF_FAILURECONSTRAINT_MIN_CONSEC_OFF_FAILURECONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR_SHIFT__PER_SHIFTCONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR__PER_MINUTES_HOURSCONSTRAINT_CONSECUTIVE_SHIFTS_RULE_NOT_ALLOWEDCONSTRAINT_WITH_LARGER_PERIOD_PER_SMALL_PERIOD_NOT_ALLOWEDCONSTRAINT_MIN_MAX_OFF_TIME_FOR_SHIFTS_NOT_ALLOWEDCONSTRAINT_CANNOT_HAVE_CONSECUTIVE_TIME_PER_MULTIPLE_SHIFTSCANNOT_GENERATE_TOUR_PATTERNS_FOR_NON_TOUR_SHIFT_TEMPLATETOUR_PATTERNS_NEEDED_TO_SCHEDULE_TOURSHIFT_TEMPLATE_ACTIVITY_PLACEMENT_MIN_MAX_MUST_BE_MULTIPLE_OF_5_MINUTESNO_SHIFT_TEMPLATE_ACTIVITY_PLACEMENT_SEQUENCES_MATCH_SHIFT_MIN_MAX_WIDTHINVALID_TOUR_PATTERNINVALID_TOUR_AGENT_COLLECTIONINVALID_TOUR_SHIFT_INSTANCE_CONFIGINVALID_TOUR_SHIFT_SEGMENT_CONFIGTOUR_SHIFT_SEGMENT_CONFIG_OVERLAPTOUR_SHIFT_SEGMENT_CONFIG_DOES_NOT_FITTOUR_SHIFT_INSTANCE_CONFIG_OVERLAPWEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_WEEK_PATTERNSWFM_AGENT_SIDS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIST_WEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIRST_WEEK_PATTERN_NUMBERS_NOT_FOUND_IN_TOUR_WEEK_PATTERNSSHIFT_TEMPLATE_HAS_NO_ASSOCIATED_SCHEDULING_AGENT_GROUPSATTEMPT_TO_BUILD_SCHEDULES_FOR_INVALID_PARENT_NODESCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MINIMUMSCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MAXIMUMNO_OPEN_TIMES_SET_OR_INHERITED_BY_PROGRAMTOUR_AGENT_COLLECTIONS_NEEDED_TO_SCHEDULE_TOURNO_PREDICTED_CALLS_IN_SCHEDULING_RANGESHIFT_TEMPLATE_MIN_WIDTH_DOW_MISMATCH

source_entity

object (ParentEntity)

source_entity

optional

The entity that the diagnostic was built in reference to.

message

string

message

optional

The message detailing the diagnostic.

nodes_checked

array[object (ParentEntity) {2}]

nodes_checked

optional

Set of all nodes checked during the diagnostics.

parent_type

enum<string>

parent_type

optional

Type of entity that the @parent_sid will reference.

Allowed values:

CALL_CENTER_NODECLIENT_NODELOCATION_NODEPROGRAM_NODEAGENT_GROUPSHIFT_TEMPLATEWFM_AGENTPLACEMENT_RULECONSTRAINT_RULENON_SKILL_ACTIVITYAGENT_AVAILABILITYOPEN_TIMESSCHEDULING_ACTIVITYSKILL_PROFICIENCYSCHEDULE_SCENARIOSKILLTOUR_PATTERNTOUR_WEEK_PATTERNTOUR_SHIFT_INSTANCE_CONFIGTOUR_SHIFT_SEGMENT_CONFIGTOUR_AGENT_COLLECTION

parent_sid

integer <int64> | string

parent_sid

optional

ID of a parent entity

Example

{
    "diagnostics": [
        {
            "level": "INFORMATION",
            "code": "GENERAL",
            "source_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
            },
            "message": "string"
        }
    ],
    "nodes_checked": [
        {
            "parent_type": "CALL_CENTER_NODE",
            "parent_sid": 0
        }
    ]
}

🔴500Server Error