GetOpenTimesBitmaps

POST

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

Gets the inherited, own, and resulting bitmaps for the open times patterns of @node_to_check for @schedule_scenario_sid and the org sending the request.
The @schedule_scenario_sid must match the scenario of the @node_to_check.
If @bitmap_type is COMPLETE, the bitmaps will be generated using all relevant pattern data.
If @bitmap_type is ONLY_WEEKMAPS, the bitmaps will be generated using only the weekmap data from the open times patterns.
If @bitmap_type is ONLY_CALENDAR_ITEMS, the bitmaps will be generated using only the calendar item data from the open times patterns.
The bitmaps will be generated for the span of @datetime_range.
Errors:

grpc.Invalid: the @node_to_check is invalid for @schedule_scenario_sid and the org making the request.
: the @datetime_range is invalid.

grpc.NotFound: the given @node_to_check doesn't exist.

grpc.Internal: error occurs when getting the open times pattern bitmaps.

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

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

DeleteOpenTimesPattern

ListOpenDateRangesForNodeOpenTimesBitmaps